Skip to content

Commit

Permalink
Add example docs site (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
Florimond Manca authored Dec 9, 2020
1 parent a01754d commit 7c26ee8
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
8 changes: 8 additions & 0 deletions example/index.md
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions scripts/docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#! /bin/sh -e

BIN="venv/bin/"

set -x

${BIN}mkdocs "$@"

0 comments on commit 7c26ee8

Please sign in to comment.