Include readme markdown with plugin instead of symlink

mcauser · Jul 28, 2022 · b8b74fb · b8b74fb
1 parent 02fb5cf
commit b8b74fb
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 7 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout master
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
 
       - name: Deploy awesome list
         uses: mhausenblas/mkdocs-deploy-gh-pages@master

diff --git a/Makefile b/Makefile
@@ -6,15 +6,11 @@ install:
 	pip install mkdocs-minify-plugin
 	pip install mkdocs-awesome-pages-plugin
 	pip install mkdocs-material
-
-link:
-	ln -sf $(BASEDIR)/README.md $(DOCDIR)/index.md
+	pip install mkdocs-include-markdown-plugin
 
 serve:
-	$(MAKE) link
 	mkdocs serve
 
 deploy:
 	$(MAKE) link
 	mkdocs gh-deploy --clean
-
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,6 @@
+---
+hide:
+   - navigation
+---
+
+{% include-markdown "../readme.md" %}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -21,6 +21,7 @@ extra:
     provider: google
     property: UA-1390021-18
 plugins:
+  - include-markdown
   - search
   - awesome-pages
   - minify:

diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,5 @@
 mkdocs
+mkdocs-minify-plugin
 mkdocs-awesome-pages-plugin
 mkdocs-material
+mkdocs-include-markdown-plugin