-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Florimond Manca
authored
Dec 9, 2020
1 parent
a01754d
commit 7c26ee8
Showing
4 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
#! /bin/sh -e | ||
|
||
BIN="venv/bin/" | ||
|
||
set -x | ||
|
||
${BIN}mkdocs "$@" |