Adding mkdocs build items for running locally on windows
silversword411 committed
May 16, 2022 at 18:48 UTC
0ee0ba7df1a4bb2826f8e134440299f01030cbc9
2 files changed
+20
.gitignore
+4
@@ -309,3 +309,7 @@ __pycache__/
309
*.odx.cs
310
*.xsd.cs
311
.DS_Store
312
+
313
+# When running mkdocs locally as dev
314
+docs/__pycache__/
315
+docs/env/
\ No newline at end of file
docs/startdevmkdocs.ps1
new
+16
@@ -0,0 +1,16 @@
1
+# This is for running mkdocs locally on windows only.
2
+# Make sure you change directory to your docs folder before starting this process
3
+
4
+#Activate python
5
+python -m venv env
6
+.\env\Scripts\activate
7
+
8
+#Install requirements first time only
9
+python -m pip install --upgrade pip #only 1st time
10
+pip install pytest #only 1st time
11
+pip install mkdocs #only 1st time
12
+pip install mkdocs-material #only 1st time
13
+
14
+#Run mkdocs and look at changes as you make them
15
+mkdocs serve
16
+start http://localhost:8010 #Opens Browser
\ No newline at end of file