init mkdocs

Signed-off-by: Maciej Pijanowski <[email protected]>
Dasharo · Nov 9, 2021 · a98c8a2 · a98c8a2
1 parent ca6b76d
commit a98c8a2
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 0 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -0,0 +1,17 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+      - main
+      - mkdocs
+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 --force
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+venv/
+site/
diff --git a/README.md b/README.md
@@ -1,2 +1,11 @@
 # vpub
 Dasharo Open Source Firmware vPub (aka 3mdeb vPub) - website, presentations and notes
+
+# Local build
+
+```bash
+$ virtualenv -p $(which python3) venv
+$ source venv/bin/activate
+$ pip install mkdocs mkdocs-material
+$ mkdocs build
+```
diff --git a/docs/CNAME b/docs/CNAME
@@ -0,0 +1 @@
+vpub.dasharo.com
diff --git a/docs/images/dasharo-logo.png b/docs/images/dasharo-logo.png
diff --git a/docs/images/favicon.png b/docs/images/favicon.png
diff --git a/dasharo-osf-vpub-fall-2021.md → docs/index.md b/dasharo-osf-vpub-fall-2021.md → docs/index.md
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -0,0 +1,11 @@
+:root {
+  --md-primary-fg-color:        #29363b;
+  --md-primary-fg-color--light: #808080;
+  --md-primary-fg-color--dark:  #29363b;
+  --md-accent-fg-color:         hsla(117, 66%, 51%, 0.7);
+  --md-text-font-family:        "Oswald",sans-serif;
+}
+
+:root > * {
+  --md-typeset-a-color:         #38d430;
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,16 @@
+site_name: Dasharo Open Source Firmware vPub (aka 3mdeb vPub)
+site_url: https://vpub.dasharo.com/
+theme:
+    name: material
+    favicon: images/favicon.png
+    logo: images/dasharo-logo.png
+extra_css:
+    - stylesheets/extra.css
+google_analytics:
+    - UA-39420295-13
+    - auto
+markdown_extensions:
+    - pymdownx.highlight
+    - pymdownx.superfences
+    - pymdownx.keys
+    - attr_list