docs: add page on editing docs

urbanSpatial · May 1, 2021 · ec2de54 · ec2de54
1 parent f200bfa
commit ec2de54
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 # package caches
 /node_modules
 /vendor
+/.venv/
 
 # built assets
 /public/css/

diff --git a/docs/development/.pages b/docs/development/.pages
@@ -0,0 +1,3 @@
+nav:
+- quick-start.md
+- ...
diff --git a/docs/development/docs.md b/docs/development/docs.md
@@ -0,0 +1,27 @@
+# Documentation
+
+## Working with live preview
+
+- Install Chef Habitat
+- Install Habitat packages:
+
+    ```bash
+    sudo hab pkg install jarvus/mkdocs
+    ```
+
+- Create python environment:
+
+    ```bash
+    hab pkg exec jarvus/mkdocs python -m venv "./.venv"
+    source "./.venv/bin/activate"
+    pip install --upgrade pip
+    pip install mkdocs mkdocs-material mkdocs-awesome-pages-plugin fontawesome_markdown
+    ```
+
+- Launch live preview server:
+
+    ```bash
+    mkdocs serve
+    ```
+
+- Open <http://localhost:8000/>