satchlj
/
satchlj.com
1
2
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Improve README

This commit is contained in:
timvisee 2019-07-04 14:01:55 +02:00
parent 10e2710317
commit 889f87140b
No known key found for this signature in database
GPG Key ID: B8DB720BC383E172
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -5,12 +5,13 @@
# timvisee.com
The source code for my personal website.
View it live at [timvisee.com](https://timvisee.com/).
View it live at [timvisee.com][site].
![Homepage screenshot](./screenshot.png)
[![Homepage screenshot](./screenshot.png)][site]
## Content
The majority of the content is formatted in Markdown, located in the
[`content/`](./content/) directory.
[`./content`](./content/) directory.
It includes a custom theme as well ([zenn][zenn]) for the visuals.
This website is built with [Zola][zola], a static website generator.
@ -18,7 +19,8 @@ See it's documentation for more information on how this project is structured.
Any pull requests for changes on the website are welcome.
To run a local instance of this website, be sure to install [Zola][zola] first.
## Usage
To run a local instance of this website, be sure to install [`zola`][zola] first.
Then run:
```bash
@ -28,11 +30,22 @@ cd timvisee.com
# Build and serve a local instance
zola serve
# Open: 127.0.0.1:1111
# Edit files in ./content, view live changes your browser
```
The latest [`deploy`][branch-deploy] branch is automatically deployed live at [timvisee.com][site].
## License
This project is released under the GNU GPL-3.0 license.
Check out the [LICENSE](./LICENSE) file for more information.
Check out the [LICENSE][license] file for more information.
[zola]: https://getzola.org./
Feel free to use parts of this project, such as the custom [zenn][zenn] theme,
in your own project conform the [LICENSE][license].
[site]: https://timvisee.com/
[zola]: https://getzola.org/
[zenn]: ./themes/zenn/
[branch-deploy]: https://gitlab.com/timvisee/timvisee.com/tree/deploy
[license]: ./LICENSE