chore: migrate docs from gatsby to mkdocs

Author: Pankaj Agrawal

.github/workflows/build-docs.yml

@@ -16,18 +16,18 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: borales/[email protected]
+      - uses: actions/checkout@v1
       - name: Set up Python
         uses: actions/setup-python@v1
         with:
           python-version: "3.8"
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12'
       - name: Capture branch and tag
         id: branch_name
         run: |
           echo "SOURCE_BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
           echo "SOURCE_TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
-      - name: install dependencies
-        run: make dev-docs
       - name: Build docs website
         run: make build-docs-website

.github/workflows/docs.yml

@@ -10,21 +10,23 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: borales/[email protected]
+      - uses: actions/checkout@v1
       - name: Set up Python
         uses: actions/setup-python@v1
         with:
           python-version: "3.8"
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '12'
       - name: Capture branch and tag
         id: branch_name
         run: |
           echo "SOURCE_BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
           echo "SOURCE_TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
-      - name: install dependencies
-        run: make dev-docs
       - name: Build docs website
         run: make build-docs-website
+      - name: Build docs API reference
+        run: make build-docs-api
       - name: Deploy all docs
         uses: peaceiris/actions-gh-pages@v3
         with:

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+This project follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format for changes and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+
+## [Unreleased]
+
+## [1.3.0] - Coming soon!

Makefile

@@ -1,17 +1,16 @@
-
-dev-docs:
-	cd docs && yarn install
-
 build-docs:
 	@$(MAKE) build-docs-website
+	@$(MAKE) build-docs-api
 
-build-docs-website: dev-docs
+build-docs-website:
 	mkdir -p dist
-	cd docs && yarn build
-	cp -R docs/public/* dist/
+	docker build -t squidfunk/mkdocs-material ./docs/
+	docker run --rm -t -v ${PWD}:/docs squidfunk/mkdocs-material build
+	cp -R site/* dist/
 
-docs-local:
-	cd docs && yarn start
+docs-local-docker:
+	docker build -t squidfunk/mkdocs-material ./docs/
+	docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
 
 test:
 	mvn test

README.md

@@ -82,7 +82,8 @@ See **[example](./example/README.md)** for maven or gradle configurations includ
 
 ## Credits
 
-* [Gatsby Apollo Theme for Docs](https://github.com/apollographql/gatsby-theme-apollo/tree/master/packages/gatsby-theme-apollo-docs)
+* [MkDocs](https://www.mkdocs.org/)
+* [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
 
 ## License
 

docs/.prettierignore

@@ -0,0 +1,2 @@
+FROM squidfunk/mkdocs-material
+RUN pip install mkdocs-git-revision-date-plugin

docs/.prettierrc

@@ -0,0 +1,2 @@
+[comment]: <> (Includes Changelog content entire file as a snippet)
+--8<-- "CHANGELOG.md"