From a80c1ae40cc87b3e6f3b7f04478a990c17e7e3c7 Mon Sep 17 00:00:00 2001 From: Christian Decker Date: Tue, 6 Dec 2022 15:09:10 +0100 Subject: [PATCH] docs: Switch to mkdocs for documentation --- doc/requirements.txt | 4 ++++ mkdocs.yml | 27 +++++++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 doc/requirements.txt create mode 100644 mkdocs.yml diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..7032599c9 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,4 @@ +mkdocs-exclude +mkdocs-material +mkdocs +Jinja2==3.1.0 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..2c72d6817 --- /dev/null +++ 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