infrastructure/hugo-fresh
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Finish up README

Browse Source
This commit is contained in:
lucperkins
2018-08-04 13:00:29 +02:00
parent fed863017b
commit 7dcab1c726
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -4,6 +4,8 @@
![Fresh theme logo](fresh.png) ![Fresh theme logo](fresh.png)
> This theme is for landing pages only. If you'd like to extend the theme to include other types of pages—blog posts, documentation pages, etc.—feel free to submit a pull request.
## Getting started ## Getting started
To create a new site using this theme: To create a new site using this theme:
@@ -19,11 +21,15 @@ git clone https://github.com/lucperkins/hugo-fresh themes/hugo-fresh
rm config.toml rm config.toml
# Fetch the example config # Fetch the example config
curl -O https://github.com/lucperkins/hugo-fresh/blob/master/exampleSite/config.yaml curl -O https://raw.githubusercontent.com/lucperkins/hugo-fresh/master/exampleSite/config.yaml
# Run the site locally # Run the site locally
hugo server hugo server
# Open the site in your browser # Open the site in your browser
open http://localhost:1313 open http://localhost:1313
``` ```
## Customizing your page
There's a wide variety of customizations that you can make to your Hugo Fresh landing page by modifying the `config.yaml` file that you downloaded. That file provides documentation for what the various config values represent.