Free Motion Capture for Everyone πβ¨
TypeScript
Start building Knowledge Base with `mkdocs` (#212)
jonmatthis3ad57acf13d1
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.ymlnew file mode 100644index 00000000..669e2d21--- /dev/null+++ b/.github/workflows/ci.yml@@ -0,0 +1,16 @@+#originally copied from https://squidfunk.github.io/mkdocs-material/publishing-your-site/#with-github-actions+name: ci+on:+ push:+ branches:+ - main+jobs:+ deploy:+ runs-on: ubuntu-latest+ steps:+ - uses: actions/checkout@v2+ - uses: actions/setup-python@v2+ with:+ python-version: 3.x+ - run: pip install mkdocs-material+ - run: mkdocs gh-deploy --forcediff --git a/docs/img.png b/docs/img.pngnew file mode 100644index 00000000..04edc8b1Binary files /dev/null and b/docs/img.png differdiff --git a/docs/index.md b/docs/index.mdnew file mode 100644index 00000000..201585ad--- /dev/null+++ b/docs/index.md@@ -0,0 +1,16 @@+# Welcome to the FreeMoCap++Its 24 July 2022, and I'm just playing around with `mkdocs` right now. Seems pretty cool!++We're planning to build a Knowledge Base that roughly follows the [structure outlined here](https://docs.google.com/presentation/d/1Xk15eYjGnGjuUlPOJgSoF2z5fhktZXMHNP_00blWi_s/edit#slide=id.gac39de1498_0_345)+++...but until then, I'm just going to point you back to the (`README.md`) in the main repository:+https://github.com/freemocap/freemocap++We've also got a pretty nice website:+https://freemocap.org++Work in progress, stay tuned!!++β¨πβ¨\ No newline at end of filediff --git a/mkdocs.yml b/mkdocs.ymlnew file mode 100644index 00000000..39dc58d5--- /dev/null+++ b/mkdocs.yml@@ -0,0 +1,6 @@+# originally copied from - https://squidfunk.github.io/mkdocs-material/creating-your-site/#configuration++# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json+site_name: My Docs+theme:+ name: material\ No newline at end of filediff --git a/requirements.txt b/requirements.txtindex ab15832a..2aacd93e 100644--- a/requirements.txt+++ b/requirements.txt@@ -1,4 +1,4 @@-ipython+ipython==8.2.0numpy>=1.19pydantic==1.9.0uvicorn==0.16.0@@ -28,3 +28,4 @@ pytest-cov==3.0.0pyinstaller==5.2pyinstaller-hooks-contrib==2022.8black[d]==22.6.0+mkdocs-material==8.3.9