diff --git a/LICENSE.md b/LICENSE similarity index 100% rename from LICENSE.md rename to LICENSE diff --git a/README.md b/README.md index 7220cf8..7b0d9be 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,8 @@ theme = 'notrack' [params] author = '' -siteHeading = '' # optional, defaults to author +# optional, defaults to author: +siteHeading = '' ``` Now you are ready to add the first content to the web page. Create the home @@ -125,7 +126,8 @@ or deploy it somewhere according to the instructions form Hugo: You can further extend the home page: -- Add an [image](#the-image-shortcode) (for example like in the demonstration web page) +- Add an [image](#the-image-shortcode) (for example like in the demonstration + web page) - Add a [footer](#how-to-set-a-footer) (that will be shown on all pages) #### How to create a blog @@ -189,7 +191,9 @@ There is nothing special about the About Me page, but the theme supplies a couple of shortcodes that can be useful if you want to display social links like in the demonstration site: -Example of social link shortcodes +Example of social link shortcodes To prepare for using one of the shortcodes, configure your social media user names like this in the site configuration: @@ -201,7 +205,7 @@ email = '' ``` For all available social icons, see the -[`data/notrack/social.yaml`](https://github.com/gevhaz/hugo-theme-notrack/blob/topic/improve-intro-instruction/data/notrack/social.yaml) +[`data/notrack/social.yaml`](https://github.com/gevhaz/hugo-theme-notrack/blob/master/data/notrack/social.yaml) file. There are 65 of them. Then, create a new page, for example like this: @@ -277,7 +281,6 @@ $ hugo new tags/_index.md The only needed content is a menu definition in the front matter, like this: - ```toml [menu.main] parent = 'blog' @@ -345,21 +348,21 @@ all the shortcodes in a table, and show how to use the non-trivial ones. #### Shortcodes provided by Notrack -| Category | Shortcode | Description | -| :--- | :--- | :--- | -| **Contact info** | `contact-box` | Displays contact info set in `params.social` | -| | `social` | Displays contact info set in `params.social` | -| **Photo Gallery** | `gallery-category` | Container for `gallery-photo` shortcodes | -| | `gallery-modal` | HTML to allow for full page view of gallery photos | -| | `gallery-photo` | Include a photo in a gallery | -| | `gallery-script` | Script to allow for full page view of gallery photos | -| **General** | `image` | Image for use in any page. See example in [How to create a blog](#how-to-create-a-blog) | -| | `video` | Similar to an ordinary `