From db58f73d7c0a1e192b0a0b860f976e62944415a2 Mon Sep 17 00:00:00 2001
From: Sameer Rahmani <lxsameer@gnu.org>
Date: Thu, 18 May 2023 00:43:19 +0100
Subject: [PATCH] docs: Add a very basic mkdocs setup

---
 docs/index.md         | 17 ++++++++++
 docs/requirements.txt |  2 ++
 mkdocs.yml            | 78 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 97 insertions(+)
 create mode 100644 docs/index.md
 create mode 100644 mkdocs.yml

diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..000ea34
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 4c8f017..233599b 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1 +1,3 @@
 mkdocs-material
+mike
+mkdocs-git-revision-date-localized-plugin
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 0000000..81827ed
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,78 @@
+site_name: Serene Programming Language
+repo_url: https://devheroes.codes/serene/serene
+repo_name: Serene
+copyright: Copyright &copy; 2019 - 2023 Sameer Rahmani
+edit_uri: edit/master/docs/
+
+theme:
+  name: material
+  logo: /img/logo.png
+  favicon: images/favicon.png
+  icon:
+    repo: fontawesome/brands/git-alt
+    edit: material/pencil
+    view: material/eye
+
+  features:
+    - content.action.edit
+    - navigation.tracking
+    - navigation.instant
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.sections
+    - navigation.expand
+    - navigation.indexes
+    - toc.follow
+    - toc.integrate
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - search.share
+    - header.autohide
+    - navigation.footer
+
+  palette:
+
+
+    # Palette toggle for light mode
+    - scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+      primary: deep purple
+      accent: amber
+    # Palette toggle for dark mode
+    - scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+      primary: deep purple
+      accent: amber
+
+
+
+
+plugins:
+  - git-revision-date-localized:
+      enable_creation_date: true
+  - search
+  # - social:
+  #     concurrency: 16
+  - tags
+  - mike:
+      # These fields are all optional; the defaults are as below...
+      alias_type: symlink
+      redirect_template: null
+      deploy_prefix: ''
+      canonical_version: null
+      version_selector: true
+      css_dir: css
+      javascript_dir: js
+
+extra:
+  version:
+    provider: mike
+  social:
+    - icon: fontawesome/brands/mastodon
+      link: https://social.lxsameer.com/@lxsameer
+  generator: false