Skip to content

Commit f5343cf

Browse files
committed
add update docs to readme
1 parent 76f25f2 commit f5343cf

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,20 @@ https://lightningames.github.io/pylnbits/
1111
See also [Powered-by-LNBits](https://github.com/lnbits/lnbits/wiki/Powered-by-LNbits) for more resources.
1212
This project, [pylnbits](https://github.com/lightningames/pylnbits), is also listed on the Powered by LNbits wiki.
1313

14+
## Updating the docs
15+
16+
See mkdocs for guidance on how to update docs and also https://github.com/lightningames/pylnbits/blob/main/mkdocs.yml
17+
18+
19+
deploy to github pages:
20+
21+
https://www.mkdocs.org/user-guide/deploying-your-docs/#github-pages
22+
23+
24+
```
25+
mkdocs gh-deploy
26+
```
27+
1428
## Getting Started
1529

1630
version at least python3.8

0 commit comments

Comments
 (0)