Documentation

squidfunk · Jun 24, 2022 · 3cce3ea · 3cce3ea
1 parent 10a2b4f
commit 3cce3ea
Show file tree

Hide file tree

Showing 7 changed files with 217 additions and 61 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -48,6 +48,8 @@ jobs:
         run: |
           pip install .
           pip install \
+            mkdocs-git-committers-plugin-2>=0.4 \
+            mkdocs-git-revision-date-plugin>=0.3 \
             mkdocs-minify-plugin>=0.3 \
             mkdocs-redirects>=1.0 \
             mkdocs-rss-plugin>=0.17

diff --git a/docs/insiders/index.md b/docs/insiders/index.md
@@ -180,9 +180,10 @@ which are currently exclusively available to sponsors:
 
 <div class="mdx-columns" markdown>
 
+- [x] [Document contributors] :material-alert-decagram:{ .mdx-pulse title="Added on June 24, 2022" }
 - [x] [Automatic light / dark mode] :material-alert-decagram:{ .mdx-pulse title="Added on June 11, 2022" }
 - [x] [Content tabs: anchor links] :material-alert-decagram:{ .mdx-pulse title="Added on June 4, 2022" }
-- [x] [Navigation pruning] :material-alert-decagram:{ .mdx-pulse title="Added on May 25, 2022" }
+- [x] [Navigation pruning]
 - [x] [Tooltips]
 - [x] [Chinese search support]
 - [x] [Tag icons]
@@ -281,13 +282,14 @@ are released for general availability.
 - [x] [Tooltips]
 - [x] [Content tabs: anchor links]
 - [x] [Automatic light / dark mode]
-- [ ] Document authors/contributors
+- [x] [Document contributors]
 
   [Privacy plugin]: ../setup/ensuring-data-privacy.md
   [Card grids]: ../reference/grids.md
   [Tooltips]: ../reference/tooltips.md
   [Content tabs: anchor links]: ../reference/content-tabs.md#anchor-links
   [Automatic light / dark mode]: ../setup/changing-the-colors.md#automatic-light-dark-mode
+  [Document contributors]: ../setup/adding-a-git-repository.md#document-contributors
 
 #### $ 16,000 – Chipotle
 

diff --git a/docs/schema/plugins.json b/docs/schema/plugins.json
@@ -42,6 +42,12 @@
     "external": {
       "description": "External plugins, schema provided by us",
       "oneOf": [
+        {
+          "$ref": "plugins/external/git-authors.json"
+        },
+        {
+          "$ref": "plugins/external/git-committers.json"
+        },
         {
           "$ref": "plugins/external/git-revision-date.json"
         },

diff --git a/docs/schema/plugins/external/git-authors.json b/docs/schema/plugins/external/git-authors.json
@@ -0,0 +1,39 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema",
+  "title": "Git authors plugin",
+  "oneOf": [
+    {
+      "markdownDescription": "https://timvink.github.io/mkdocs-git-authors-plugin/",
+      "enum": [
+        "git-authors"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "git-authors": {
+          "markdownDescription": "https://timvink.github.io/mkdocs-git-authors-plugin/options.html",
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "title": "Enable plugin",
+              "markdownDescription": "https://timvink.github.io/mkdocs-git-authors-plugin/options.html#enabled",
+              "type": "boolean",
+              "default": true
+            },
+            "exclude": {
+              "title": "List of Markdown file patterns",
+              "markdownDescription": "https://timvink.github.io/mkdocs-git-authors-plugin/options.html#exclude",
+              "type": "array",
+              "items": {
+                "pattern": "(\\*|\\.md)$"
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  ]
+}
diff --git a/docs/schema/plugins/external/git-committers.json b/docs/schema/plugins/external/git-committers.json
@@ -0,0 +1,44 @@
+{
+  "$schema": "https://json-schema.org/draft-07/schema",
+  "title": "Git committers plugin",
+  "oneOf": [
+    {
+      "markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2",
+      "enum": [
+        "git-committers"
+      ]
+    },
+    {
+      "type": "object",
+      "properties": {
+        "git-authors": {
+          "markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2",
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "title": "Enable plugin",
+              "markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config",
+              "type": "boolean",
+              "default": true
+            },
+            "repository": {
+              "title": "Repository slug",
+              "markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config",
+              "type": "string"
+            },
+            "token": {
+              "title": "Personal access token",
+              "markdownDescription": "https://github.com/ojacques/mkdocs-git-committers-plugin-2#config",
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "repository"
+          ]
+        }
+      },
+      "additionalProperties": false
+    }
+  ]
+}