diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b95ce7..754a2f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,14 @@ cd mkdocs-click scripts/install ``` +## Example docs site + +You can run the example docs site that lives in `example/` locally using: + +```bash +scripts/docs serve +``` + ## Testing and linting Once dependencies are installed, you can run the test suite using: diff --git a/example/index.md b/example/index.md new file mode 100644 index 0000000..d2badc0 --- /dev/null +++ b/example/index.md @@ -0,0 +1,8 @@ +# Introduction + +This demo site shows the rendering of the [MkDocs](https://www.mkdocs.org/) CLI itself through `mkdocs-click`. + +::: mkdocs-click + :module: mkdocs.__main__ + :command: cli + :depth: 1 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..921563f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,9 @@ +# NOTE: this is not an actual docs site for `mkdocs-click`, but rather a +# demo site to demonstrate the abilities of `mkdocs-click`. +site_name: mkdocs-click example +theme: readthedocs + +docs_dir: example + +markdown_extensions: + - mkdocs-click diff --git a/scripts/docs b/scripts/docs new file mode 100755 index 0000000..a5685f6 --- /dev/null +++ b/scripts/docs @@ -0,0 +1,7 @@ +#! /bin/sh -e + +BIN="venv/bin/" + +set -x + +${BIN}mkdocs "$@"