Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ build: envvar
@echo "${GREEN}Makefile: Build mkdocs site${RESET}"
$(PYTHON) -m venv /tmp/venv
. /tmp/venv/bin/activate
$(PIP) install mkdocs mkdocs-awesome-pages-plugin mkdocs-htmlproofer-plugin mkdocs-material mkdocs-redirects
$(PIP) install mkdocs mkdocs-awesome-nav mkdocs-htmlproofer-plugin mkdocs-material mkdocs-redirects
@echo
@echo '*** BEGIN cat mkdocs.yml ***'
@cat mkdocs.yml
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ We more than welcome contributions to KubeVirt documentation. Please reach out i

You can find the markdown that powers the user guide in `./docs`, most commits are to that area.

We use [mkdocs](https://www.mkdocs.org/) markdown engine with [mkdocs-awesome-pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/) plugin
We use [mkdocs](https://www.mkdocs.org/) markdown engine with [mkdocs-awesome-nav](https://github.com/lukasgeiter/mkdocs-awesome-nav/) plugin
- mkdocs config file
- Each subdirectory of `./docs` contains a `.pages` file. We use this to force the ordering of pages. Alphabetical ordering is not ideal for technical documentation.
- Each subdirectory of `./docs` contains a `.nav.yml` file. We use this to force the ordering of pages. Alphabetical ordering is not ideal for technical documentation.

#### Sign your commits

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ site_dir: site
plugins:
- search:
separator: '[\s\-,:!=\[\]\(\)"/]+|\.(?!\d)'
- awesome-pages
- awesome-nav
- redirects:
redirect_maps:
'operations/customize_components.md': 'cluster_admin/customize_components.md'
Expand Down
2 changes: 1 addition & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
publish = "./site"
command = """
pip install --upgrade pip;
pip install mkdocs mkdocs-awesome-pages-plugin mkdocs-material mkdocs-redirects;
pip install mkdocs mkdocs-awesome-nav mkdocs-material mkdocs-redirects;
sed -i 's|site_url: https://kubevirt.io/docs|site_url: https://kubevirt.io/|' /opt/build/repo/mkdocs.yml;
sed -i 's/docs_dir: docs/docs_dir:/' /opt/build/repo/mkdocs.yml;
echo '*** BEGIN /opt/build/repo/mkdocs.yml ***';
Expand Down