diff --git a/doc/dev/contributors/index.md b/doc/dev/contributors/index.md new file mode 100644 index 000000000..4796167e6 --- /dev/null +++ b/doc/dev/contributors/index.md @@ -0,0 +1 @@ +# Developer Documentation diff --git a/doc/dev/index.md b/doc/dev/index.md new file mode 100644 index 000000000..4796167e6 --- /dev/null +++ b/doc/dev/index.md @@ -0,0 +1 @@ +# Developer Documentation diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 000000000..f8a931341 --- /dev/null +++ b/doc/index.md @@ -0,0 +1,10 @@ + +Core Lightning (previously c-lightning) is a lightweight, highly +customizable and [standard compliant][std] implementation of the +Lightning Network protocol. + +This documentation site will walk you through your first steps, teach +you how to develop on top of CLN and act as a reference for veteran +programmers. + +[std]: https://github.com/lightning/bolts diff --git a/doc/reference/index.md b/doc/reference/index.md new file mode 100644 index 000000000..aa7d2c531 --- /dev/null +++ b/doc/reference/index.md @@ -0,0 +1 @@ +# Core-Lightning References diff --git a/doc/user/index.md b/doc/user/index.md new file mode 100644 index 000000000..e69de29bb diff --git a/mkdocs.yml b/mkdocs.yml index 2c72d6817..ae2e7fbed 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,11 +1,12 @@ site_name: Core Lightning docs_dir: doc - +use_directory_urls: false + plugins: - search - exclude: regex: - - ".*\\.[1578]" + - ".*\\.[1578]$" theme: name: material features: @@ -14,14 +15,42 @@ theme: - navigation.tabs.sticky - navigation.tracking - navigation.sections - + - navigation.expand + - navigation.indexes + markdown_extensions: - pymdownx.highlight: anchor_linenums: true - pymdownx.inlinehilite - pymdownx.snippets - pymdownx.superfences + - toc: + toc_depth: 2 python: install: - requirements: doc/requirements.txt + +nav: + - "Welcome": index.md + - Users: + - Installation: "INSTALL.md" + - "Frequently Asked Question": "FAQ.md" + - "TOR": "TOR.md" + - Developers: + - dev/index.md + - "Developing a plugin": PLUGINS.md + - "Contributors": + - dev/contributors/index.md + - "Writing JSON Schemas": schemas/WRITING_SCHEMAS.md + - Fuzzing: FUZZING.md + - "Reproducible Builds": REPRODUCIBLE.md + - "Coding Style": STYLE.md + + - Reference: + - reference/index.md + - "Man Pages": + - lightningd-rpc: lightningd-rpc.7.md + - "lightning-withdraw": "./lightning-withdraw.7.md" + - About: + - Changelog: "CHANGELOG.md"