yann/hugo-scroll
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs(README): add link to setup guide & add section on starting fresh

Browse source
This commit is contained in:
Jan Raasch 2020-08-17 11:56:41 +02:00 committed by GitHub
parent fdcb6abc33
commit 7bc116b238
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -8,7 +8,7 @@
For a current & working demo of this theme please check out https://janraasch.github.io/hugo-scroll/ 🎯. For a current & working demo of this theme please check out https://janraasch.github.io/hugo-scroll/ 🎯.
## Quick Start ## Installation
If you already have a hugo site on your machine, you can simply add this theme via If you already have a hugo site on your machine, you can simply add this theme via
@ -26,11 +26,19 @@ cd hugo-scroll
hugo server --source=exampleSite --themesDir=../.. hugo server --source=exampleSite --themesDir=../..
``` ```
For more information read the official [setup guide][hugo-setup-guide] of Hugo.
## Adjust configuration / config.toml ## Adjust configuration / config.toml
Please check out the [config.toml](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/config.toml) included on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite) of this theme. Please check out the [config.toml](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/config.toml) included on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite) of this theme.
## Adding content ## Content & structure
### Starting fresh
If you are starting fresh, simply copy over the contents of the `exmapleSite`-directory included in this theme to your source directory. That should give you a good idea about how things works, and then you can go on from there.
### Adding content
You can add **a new section to the homepage** via running You can add **a new section to the homepage** via running
@ -63,3 +71,5 @@ Please consider supporting my work on this theme via [PayPal][paypal-dot-me].
[paypal-dot-me]: https://www.paypal.me/janraasch/29,00 [paypal-dot-me]: https://www.paypal.me/janraasch/29,00
[insert-coins-svg]: https://img.shields.io/badge/insert-coins-11dde2.svg [insert-coins-svg]: https://img.shields.io/badge/insert-coins-11dde2.svg
[hugo-setup-guide]: https://gohugo.io/getting-started/installing