Restructured documentation

mkdocs-material · Jul 30, 2023 · f9f0a78 · f9f0a78
1 parent 0385083
commit f9f0a78
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 6 deletions.
diff --git 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
@@ -4,13 +4,16 @@ 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 }
 
 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
@@ -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