History

Carlos Santana 20741cdbcc clean up docker workflow instructions and scripts (#4739 ) * clean up docker workflow for website Signed-off-by: Carlos Santana <csantana23@gmail.com> * add links to docker and colima Signed-off-by: Carlos Santana <csantana23@gmail.com> * add images Signed-off-by: Carlos Santana <csantana23@gmail.com> * fix formatting Signed-off-by: Carlos Santana <csantana23@gmail.com> * adding flexibility to run docker scripts from any directory Signed-off-by: Carlos Santana <csantana23@gmail.com>		2022-02-16 04:50:40 -08:00
..
Dockerfile	Docker instructions (#4733 )	2022-02-14 17:35:58 -08:00
README.md	Grammar fix (#4455 )	2021-11-09 02:28:43 -08:00
run.sh	clean up docker workflow instructions and scripts (#4739 )	2022-02-16 04:50:40 -08:00
test.sh	clean up docker workflow instructions and scripts (#4739 )	2022-02-16 04:50:40 -08:00

Development notes for working with mkdocs

You can use a Docker container and run MkDocs from the container, so no local installation of mkdocs is required:

You need to have Docker installed and running on your system
There are helper configurations installed if you have npm from Node.JS installed.
Build the development docker container image, this is only need it once if the dependencies have not changed.
```
npm run dev:build
```
To start developing run the following command in the root directory of the git repo (where package.json and mkdocs.yaml are located)
```
npm run dev
```
Open a browser to http://localhost:8000, where you will see the documentation site. This will live update as you save changes to the Markdown files in the docs directory.
To stop developing run the following command in another terminal window, which will terminate the docker container
```
npm run dev:stop
```
To build the static HTML files including both mkdocs and hugo run the following command.
```
npm test
```
To view additional npm scripts run the following command
```
npm run
```