diff options
author | Frank Taillandier <frank@forestry.io> | 2020-09-26 11:27:11 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-26 11:27:11 +0300 |
commit | c20b253efca3536e0a1e87c514c5bd0c119969d0 (patch) | |
tree | f2dc40f9e2ddbb32b34c252ddbac903a9e80bb66 | |
parent | 608af7f1ee46c10e266bd3e2b1af3e6f81e1f883 (diff) |
docs: quickstart from the command line
How to start to use this theme from scratch if not using the Forestry starter.
Fix #55
-rw-r--r-- | README.md | 45 |
1 files changed, 44 insertions, 1 deletions
@@ -6,10 +6,53 @@ A port of [Narative](https://www.narative.co/)'s Gatsby theme [Novela](https://w ![](https://raw.githubusercontent.com/forestryio/hugo-theme-novela/master/images/tn.png) -<a href="https://app.forestry.io/quick-start?repo=forestryio/novela-hugo-starter&engine=hugo&version=0.62.2"> +The easiest way to get started is to import this theme in Forestry CMS in a single click: + +<a href="https://app.forestry.io/quick-start?repo=forestryio/novela-hugo-starter&engine=hugo&version=0.75.1"> <img alt="Import this project into Forestry" src="https://assets.forestry.io/import-to-forestryK.svg" /> </a> +## Install from the command line + +This theme uses [Hugo modules](https://gohugo.io/hugo-modules/use-modules/). + +Create a new Hugo site and initialize your project as a module: + +``` +hugo new site my-awesome-blog +cd my-awesome-blog +hugo mod init +``` + +Edit your `config.toml` to add theme settings: + + +```toml +# Novela settings +theme = "github.com/forestryio/hugo-theme-novela" + +paginate = 6 + +[social] +twitter= "https://twitter.com/forestryio" +github= "https://github.com/forestryio/novela-hugo-starter" +linkedin= "https://www.linkedin.com/company/forestry.io"instagram = "#" +instagram = "#" +dribbble = "#" +youtube = "#" + +[taxonomies] +author = "authors" + +``` + +Create your first draft post and preview it locally: + +``` +hugo new post/my-first-post.md +hugo server -D +``` + ## Customization ### Logo |