Skip to content

Commit 0c2da8c

Browse files
committed
add support for mkdocs
1 parent 93367b9 commit 0c2da8c

4 files changed

Lines changed: 58 additions & 0 deletions

File tree

docs/_assets/meshcore_tm.svg

Lines changed: 14 additions & 0 deletions
Loading

docs/_stylesheets/extra.css

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:root {
2+
--md-primary-fg-color: #1F2937;
3+
--md-primary-fg-color--light: #1F2937;
4+
--md-primary-fg-color--dark: #1F2937;
5+
--md-accent-fg-color: #1F2937;
6+
}
7+
8+
/* hide git repo version */
9+
.md-source__fact--version {
10+
display: none;
11+
}

docs/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Welcome
2+
3+
Welcome to the MeshCore documentation.
4+
5+
## Building and viewing Docs
6+
7+
```
8+
pip install mkdocs
9+
pip install mkdocs-material
10+
```
11+
12+
* `mkdocs serve` - Start the live-reloading docs server.
13+
* `mkdocs build` - Build the documentation site.

mkdocs.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
site_name: MeshCore Docs
2+
site_url: https://meshcore-dev.github.io/meshcore/
3+
site_description: Documentation for the open source MeshCore firmware
4+
5+
repo_name: meshcore-dev/meshcore
6+
repo_url: https://github.com/meshcore-dev/meshcore/
7+
edit_uri: edit/main/docs/
8+
9+
theme:
10+
name: material
11+
logo: _assets/meshcore_tm.svg
12+
features:
13+
- content.action.edit
14+
- content.code.copy
15+
- search.highlight
16+
- search.suggest
17+
- toc.integrate
18+
19+
extra_css:
20+
- _stylesheets/extra.css

0 commit comments

Comments
 (0)