adoralaura/hugo-book-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add hugo init to install instructions

Browse source
This commit is contained in:
Alex Shpak 2021-09-11 21:27:19 +02:00
parent 15ef744c94
commit d6087bd32d
1 changed files with 11 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -38,6 +38,7 @@
## Installation ## Installation
### Install as git submodule
Navigate to your hugo project root and run: Navigate to your hugo project root and run:
``` ```
@ -50,10 +51,16 @@ Then run hugo (or set `theme = "book"`/`theme: book` in configuration file)
hugo server --minify --theme book hugo server --minify --theme book
``` ```
### Via Module ### Install as hugo module
You can also add this theme as a Hugo module instead of a git submodule. You can also add this theme as a Hugo module instead of a git submodule.
Navigate to your hugo project root and edit your `config.toml`:
Start with initializing hugo modules, if not done yet:
```
hugo mod init github.com/repo/path
```
Navigate to your hugo project root and add [module] section to your `config.toml`:
```toml ```toml
[module] [module]
@ -61,15 +68,10 @@ Navigate to your hugo project root and edit your `config.toml`:
path = 'github.com/alex-shpak/hugo-book' path = 'github.com/alex-shpak/hugo-book'
``` ```
Then, to load/update the theme module, run: Then, to load/update the theme module and run hugo:
```sh ```sh
hugo mod get -u hugo mod get -u
```
Finally, run hugo:
```sh
hugo server --minify hugo server --minify
``` ```
@ -95,7 +97,7 @@ hugo server --minify --theme book
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. You can set `title` and `weight` in the front matter of pages to adjust the order and titles in the menu.
### Leaf bundle menu ### Leaf bundle menu (Deprecated)
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: Given you have the following file structure: