Move to dedicated docs website

.github/PULL_REQUEST_TEMPLATE.md

@@ -2,7 +2,7 @@
 
 - [ ] The commit message follows our [guidelines](https://github.com/get-woke/woke/blob/main/CONTRIBUTING.md)
 - [ ] Tests for the changes have been added (for bug fixes / features)
-- [ ] Docs have been added / updated (for bug fixes / features)
+- [ ] Docs have been added / updated (for bug fixes / features) see [docs/README.md](https://github.com/get-woke/woke/blob/main/docs/README.md)
 
 
 **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)

.github/workflows/docs.yml

@@ -1,14 +1,45 @@
-name: Documentation refresh
+name: MkDocs page
 
 on:
   push:
-    tags:
-      - v*
+    branches: [ main ]
+    paths:
+      - "docs/**"
+      - mkdocs.yml
+      - .github/workflows/docs.yml
+  pull_request:
+    paths:
+      - "docs/**"
+      - mkdocs.yml
+      - .github/workflows/docs.yml
 
 jobs:
-  docs:
-    name: Renew documentation
+  mkdocs:
     runs-on: ubuntu-latest
     steps:
-    - name: Pull new module version
-      uses: andrewslotin/[email protected]
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install -r docs/requirements.txt
+
+      - name: MkDocs build
+        if: github.event_name == 'pull_request'
+        run: mkdocs build
+
+      - name: MkDocs deploy
+        if: github.event_name != 'pull_request'
+        run: |
+          # Hard-code user configuration
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions"
+          mkdocs gh-deploy --force
+  markdownlint:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: nosborn/[email protected]
+        with:
+          files: docs/*.md
+          config_file: .markdownlint.json

.github/workflows/go-docs.yml

@@ -0,0 +1,14 @@
+name: Documentation refresh
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  docs:
+    name: Renew documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Pull new module version
+      uses: andrewslotin/[email protected]

.gitignore

@@ -5,3 +5,6 @@ dist/*
 # pprof files
 *.test
 *.prof
+
+# mkdocs
+site/

.markdownlint.json

@@ -2,5 +2,6 @@
   "line-length": false,
   "no-emphasis-as-heading": false,
   "no-inline-html": false,
-  "first-line-h1": false
+  "first-line-h1": false,
+  "no-duplicate-header": false
 }

.wokeignore

@@ -3,3 +3,4 @@ pkg/rule/default.yaml
 example.yaml
 README.md
 testdata
+docs/*.md