mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 01:43:36 +01:00
docs: Structure the files in mkdocs
We have 3 personas: - Users - Developers - Maintainers The first one basically cover the installation documentation. The latter two are sorted into the "Developer" category, and the reference category serves as a quick lookup for facts on anything CLN related.
This commit is contained in:
parent
a80c1ae40c
commit
178e0b6463
1
doc/dev/contributors/index.md
Normal file
1
doc/dev/contributors/index.md
Normal file
@ -0,0 +1 @@
|
||||
# Developer Documentation
|
1
doc/dev/index.md
Normal file
1
doc/dev/index.md
Normal file
@ -0,0 +1 @@
|
||||
# Developer Documentation
|
10
doc/index.md
Normal file
10
doc/index.md
Normal file
@ -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
|
1
doc/reference/index.md
Normal file
1
doc/reference/index.md
Normal file
@ -0,0 +1 @@
|
||||
# Core-Lightning References
|
0
doc/user/index.md
Normal file
0
doc/user/index.md
Normal file
35
mkdocs.yml
35
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"
|
||||
|
Loading…
Reference in New Issue
Block a user