Add project README to site

MCHellspawn · Mar 3, 2020 · e902857 · e902857
1 parent c453d71
commit e902857
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 5 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -12,8 +12,8 @@ jobs:
     steps:
     - uses: actions/checkout@v1
 
-    - name: Pull dependencies
-      run: docker-compose pull
+    - name: Build containers
+      run: docker-compose build
 
     - name: Build site
       run: docker-compose run wiki build -v

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -9,8 +9,8 @@ jobs:
     steps:
     - uses: actions/checkout@v1
 
-    - name: Pull dependencies
-      run: docker-compose pull
+    - name: Build containers
+      run: docker-compose build
 
     - name: Build site
       run: docker-compose run wiki build -v

diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,5 @@
+FROM squidfunk/mkdocs-material:latest
+
+COPY requirements.txt /docs/requirements.txt
+
+RUN pip install -U -r /docs/requirements.txt
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -2,7 +2,7 @@ version: "2.4"
 
 services:
   wiki:
-    image: squidfunk/mkdocs-material:latest
+    build: .
     volumes:
       - .:/docs
     ports:

diff --git a/docs/wiki/project-readme.md b/docs/wiki/project-readme.md
@@ -0,0 +1 @@
+{!../README.md!}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -20,12 +20,15 @@ extra:
       link: 'https://linuxacademy.com'
     - type: 'linux'
       link: 'https://jupiterbroadcasting.com'
+
 markdown_extensions:
   - admonition
   - codehilite:
       guess_lang: false
   - toc:
       permalink: true
+  - mdx_include:
+      base_path: docs
 plugins:
   - search
   - minify:

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+mdx-include==1.3.3