diff options
Diffstat (limited to 'exampleSite/content/en/blog/configuration.md')
| -rw-r--r-- | exampleSite/content/en/blog/configuration.md | 24 |
1 files changed, 17 insertions, 7 deletions
diff --git a/exampleSite/content/en/blog/configuration.md b/exampleSite/content/en/blog/configuration.md index 3a20faa..bb2199a 100644 --- a/exampleSite/content/en/blog/configuration.md +++ b/exampleSite/content/en/blog/configuration.md @@ -1,7 +1,7 @@ --- -title: "Theme Features" +title: "**Start Here:** Configuration and Content" date: 2020-07-25T02:04:06-05:00 -tags: ["code"] +tags: ["code", "features"] series: ["quickstart"] --- @@ -11,7 +11,7 @@ Here are some helpful tips for setting up this theme. Most of what you'll want to configure is demonstrated in the exampleSite `config.toml`. This is [Hugo's configuration file](https://gohugo.io/getting-started/configuration/). You can copy the `config.toml` in the `exampleSite/` to your site root get started. -<details><summary>Here are all the options included in the configuration file for this example site!</summary> +<details><summary>Here are all the options included in the (live!) configuration file for this example site!</summary> ```toml {{% md %}} @@ -21,7 +21,9 @@ Most of what you'll want to configure is demonstrated in the exampleSite `config </details> -## Syntax Highlighting +Below are some specific things you might like to configure right away. + +### Syntax Highlighting Introduction allows the use of Hugo's rich built-in syntax highlighting capabilities. See [Syntax Highlighting](https://gohugo.io/content-management/syntax-highlighting/) in the Hugo docs. @@ -42,11 +44,11 @@ Below is an example configuration for Highlight. See [Highlight in the Hugo docs tabWidth = 4 ``` -## Shortcodes +### Shortcodes -[Custom shortcodes](https://gohugo.io/templates/shortcode-templates/) can be added to a `layouts/shortcodes/` directory in your site root. Below, I use two custom shortcodes to display a data file: the current configuration file for this site! See the [source for this page](https://github.com/victoriadrake/hugo-theme-introduction/blob/master/exampleSite/content/en/blog/configuration.md) to understand how to use shortcodes. +[Custom shortcodes](https://gohugo.io/templates/shortcode-templates/) can be added to a `layouts/shortcodes/` directory in your site root. For example, I used a shortcode above to display the current configuration file for this site! You can see the shortcodes in the [raw Markdown for this page](https://github.com/victoriadrake/hugo-theme-introduction/blob/master/exampleSite/content/en/blog/configuration.md) to understand how they work. -## Show HTML in Posts +### Show HTML in Posts To ensure Hugo renders any HTML that your shortcode or other additions like Font Awesome uses in posts, make sure these lines for [the Goldmark renderer](https://gohugo.io/getting-started/configuration-markup) are in your `config.toml`: @@ -59,3 +61,11 @@ defaultMarkdownHandler = "goldmark" [markup.goldmark.renderer] unsafe = true ``` + +## Content + +The easiest way to start adding content to your site is to copy the `exampleSite` folder to your site's root directory. + +You can change the existing posts to see how it all works. Add new pages using [the `hugo new` command](https://gohugo.io/getting-started/quick-start/). + +To understand how different pages are rendered by Hugo, read [Content Organization](https://gohugo.io/content-management/organization/) in the Hugo docs. |