From f9f0a7845a0c6fb7396a5295253026d83813d2bb Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 30 Jul 2023 11:51:27 +0200 Subject: [PATCH] Restructured documentation --- README.md | 6 +----- examples/multi-site/docs/README.md | 3 +++ examples/multi-site/requirements.txt | 2 +- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 12a3131..df02d73 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,3 @@ # Examples -- [Tags] -- [Tags with icons] - - [Tags]: packages/tags/ - [Tags with icons]: packages/tags-with-icons/ +> **Warning**: Work in progress diff --git a/examples/multi-site/docs/README.md b/examples/multi-site/docs/README.md index 0c710c0..250dd9f 100644 --- a/examples/multi-site/docs/README.md +++ b/examples/multi-site/docs/README.md @@ -4,6 +4,8 @@ title: Overview # Multiple sites +Note: you need to have access to Insiders for this demo. + Download example as archive: [Download .zip][Download]{ .md-button .md-button--primary } @@ -11,6 +13,7 @@ Download example as archive: Unzip archive, change to the folder and enter: ``` bash +GH_TOKEN="your-github.token" pip install -r requirements.txt mkdocs serve ``` diff --git a/examples/multi-site/requirements.txt b/examples/multi-site/requirements.txt index df8b44f..8a3de13 100644 --- a/examples/multi-site/requirements.txt +++ b/examples/multi-site/requirements.txt @@ -18,4 +18,4 @@ # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. -mkdocs-material +mkdocs-material @ git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git