diff options
| author | Alex Shpak <alex-shpak@users.noreply.github.com> | 2021-01-26 22:20:17 +0100 |
|---|---|---|
| committer | Alex Shpak <alex-shpak@users.noreply.github.com> | 2021-01-26 22:20:30 +0100 |
| commit | d9fe59a6e9104797e8e588e919ec7008d6204b8e (patch) | |
| tree | c407f742bddd3b486f4e596ec6b4f46c4d8a6d2f /README.md | |
| parent | 012ccee53d9154e4143f86ba40e492075db861ce (diff) | |
Refactor aside menus, add extra wrapper
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -69,12 +69,12 @@ hugo server --minify --theme book ### File tree menu (default) -By default, the theme will render pages from the `content/docs` section as a menu in a tree structure. +By default, the theme will render pages from the `content/docs` section as a menu in a tree structure. You can set `title` and `weight` in the front matter of pages to adjust the order and titles in the menu. ### Leaf bundle menu -You can also use leaf bundle and the content of its `index.md` file as menu. +You can also use leaf bundle and the content of its `index.md` file as menu. Given you have the following file structure: ``` @@ -108,14 +108,14 @@ And Enable it by setting `BookMenuBundle: /menu` in Site configuration. ## Blog -A simple blog is supported in the section `posts`. +A simple blog is supported in the section `posts`. A blog is not the primary usecase of this theme, so it has only minimal features. ## Configuration ### Site Configuration -There are a few configuration options that you can add to your `config.toml` file. +There are a few configuration options that you can add to your `config.toml` file. You can also see the `yaml` example [here](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yaml). ```toml @@ -302,7 +302,7 @@ If you want lower maintenance, use one of the released versions. If you want to ### [Extra credits to contributors](https://github.com/alex-shpak/hugo-book/graphs/contributors) -Contributions are welcome and I will review and consider pull requests. +Contributions are welcome and I will review and consider pull requests. Primary goals are: - Keep it simple. |