docs: Switch to mkdocs for documentation

ElementsProject · Dec 6, 2022 · 608a479 · 608a479
1 parent d7cd3e1
commit 608a479
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 0 deletions.
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1,2 @@
+mkdocs-exclude
+mkdocs-material
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,27 @@
+site_name: Core Lightning
+docs_dir: doc
+
+plugins:
+  - search
+  - exclude:
+      regex:
+        - ".*\\.[1578]"
+theme:
+  name: material
+  features:
+    - search.suggest
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.tracking
+    - navigation.sections
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+python:
+   install:
+   - requirements: doc/requirements.txt