mirror of https://github.com/knative/docs.git
6f7060b74f
* add v0.25 mkdocs, remove v0.21 hugo Signed-off-by: Carlos Santana <csantana23@gmail.com> * remove v0.21 hugo archived Signed-off-by: Carlos Santana <csantana23@gmail.com> * add -L for curl to catch errors when missing variabled in url path Signed-off-by: Carlos Santana <csantana23@gmail.com> * fix release branch for old mkdocs version 0.24 Signed-off-by: Carlos Santana <csantana23@gmail.com> * fix message for serve Signed-off-by: Carlos Santana <csantana23@gmail.com> * adding back archive v0.21 to make PR clear Signed-off-by: Carlos Santana <csantana23@gmail.com> |
||
|---|---|---|
| .. | ||
| Dockerfile | ||
| README.md | ||
| build.sh | ||
| clean.sh | ||
| logs.sh | ||
| run.sh | ||
| test.sh | ||
README.md
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 command 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
docsdirectory. - 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