diff options
| author | Tom Whitwell <tom@whitwell.xyz> | 2018-04-23 13:03:01 +0300 |
|---|---|---|
| committer | Tom Whitwell <tom@whitwell.xyz> | 2018-04-23 13:03:01 +0300 |
| commit | ff777fd42bec012d9e0144b0f447a5175fc75acc (patch) | |
| tree | d7a117b44f3eb8d646af9c10b1dc4255120dacb4 | |
| parent | 50d59ef131ac655cd98e95a27942d158c205160b (diff) | |
add readme with config and exampleSite
| -rw-r--r-- | README.md | 26 | ||||
| -rw-r--r-- | exampleSite/config.toml | 4 | ||||
| -rw-r--r-- | exampleSite/data/links.yml | 17 |
3 files changed, 47 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..59e6294 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# Startpage theme for hugo + +## Instructions: +Create data/links.yml in your site directory + +This file takes the following format: + +```yaml +--- +- name: Some card title + colour: blue # (a valid mdl color name) + sections: # A section + - links: + - title: Google + url: https://www.google.com + - title: Bing + url: https://www.bing.com/ + - links: + - title: Hacker News + url: https://news.ycombinator.com/ + - title: Reddit r/devops + url: https://www.reddit.com/r/devops/ + - links: + - title: Al Jazeera + url: https://www.aljazeera.com/ +``` diff --git a/exampleSite/config.toml b/exampleSite/config.toml new file mode 100644 index 0000000..d7636d0 --- /dev/null +++ b/exampleSite/config.toml @@ -0,0 +1,4 @@ +baseURL = "https://example.org/" +languageCode = "en-gb" +title = "Start Page" +theme = "startpage" diff --git a/exampleSite/data/links.yml b/exampleSite/data/links.yml new file mode 100644 index 0000000..8eff2a7 --- /dev/null +++ b/exampleSite/data/links.yml @@ -0,0 +1,17 @@ +--- +- name: Some card title + colour: blue # (a valid mdl color name) + sections: # A section + - links: + - title: Google + url: https://www.google.com + - title: Bing + url: https://www.bing.com/ + - links: + - title: Hacker News + url: https://news.ycombinator.com/ + - title: Reddit r/devops + url: https://www.reddit.com/r/devops/ + - links: + - title: Al Jazeera + url: https://www.aljazeera.com/ |