2019-07-04 11:52:18 +00:00
|
|
|
[![Build and deployment status on GitLab CI][gitlab-ci-master-badge]][gitlab-ci-link]
|
|
|
|
|
|
|
|
[gitlab-ci-link]: https://gitlab.com/timvisee/timvisee.com/pipelines
|
|
|
|
[gitlab-ci-master-badge]: https://gitlab.com/timvisee/timvisee.com/badges/master/pipeline.svg
|
|
|
|
|
|
|
|
# timvisee.com
|
|
|
|
The source code for my personal website.
|
2019-07-04 12:01:55 +00:00
|
|
|
View it live at [timvisee.com][site].
|
2019-07-04 11:52:18 +00:00
|
|
|
|
2020-04-23 20:28:59 +00:00
|
|
|
[![Homepage screenshot dark](./screenshot-dark.png)][site]
|
|
|
|
[![Homepage screenshot light](./screenshot-light.png)][site]
|
2019-07-04 11:52:18 +00:00
|
|
|
|
2019-07-04 12:01:55 +00:00
|
|
|
## Content
|
2019-07-04 11:52:18 +00:00
|
|
|
The majority of the content is formatted in Markdown, located in the
|
2019-07-04 12:01:55 +00:00
|
|
|
[`./content`](./content/) directory.
|
2019-07-04 11:52:18 +00:00
|
|
|
It includes a custom theme as well ([zenn][zenn]) for the visuals.
|
|
|
|
|
|
|
|
This website is built with [Zola][zola], a static website generator.
|
|
|
|
See it's documentation for more information on how this project is structured.
|
|
|
|
|
|
|
|
Any pull requests for changes on the website are welcome.
|
|
|
|
|
2019-07-04 12:01:55 +00:00
|
|
|
## Usage
|
|
|
|
To run a local instance of this website, be sure to install [`zola`][zola] first.
|
2019-07-04 11:52:18 +00:00
|
|
|
Then run:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
# Clone the repository
|
|
|
|
git clone https://gitlab.com/timivsee/timvisee.com
|
|
|
|
cd timvisee.com
|
|
|
|
|
|
|
|
# Build and serve a local instance
|
2020-01-13 19:45:09 +00:00
|
|
|
zola serve --open
|
2019-07-04 12:01:55 +00:00
|
|
|
|
|
|
|
# Open: 127.0.0.1:1111
|
|
|
|
# Edit files in ./content, view live changes your browser
|
2019-07-04 11:52:18 +00:00
|
|
|
```
|
|
|
|
|
2019-07-04 12:01:55 +00:00
|
|
|
The latest [`deploy`][branch-deploy] branch is automatically deployed live at [timvisee.com][site].
|
|
|
|
|
2019-07-04 11:52:18 +00:00
|
|
|
## License
|
2020-10-21 22:39:19 +00:00
|
|
|
This project is released under the GNU AGPL-3.0 license.
|
2019-07-04 12:01:55 +00:00
|
|
|
Check out the [LICENSE][license] file for more information.
|
|
|
|
|
|
|
|
Feel free to use parts of this project, such as the custom [zenn][zenn] theme,
|
|
|
|
in your own project conform the [LICENSE][license].
|
2019-07-04 11:52:18 +00:00
|
|
|
|
2019-07-04 12:01:55 +00:00
|
|
|
[site]: https://timvisee.com/
|
|
|
|
[zola]: https://getzola.org/
|
2019-07-04 11:52:18 +00:00
|
|
|
[zenn]: ./themes/zenn/
|
2019-07-04 12:01:55 +00:00
|
|
|
[branch-deploy]: https://gitlab.com/timvisee/timvisee.com/tree/deploy
|
|
|
|
[license]: ./LICENSE
|