mirror of
https://github.com/monero-project/monero-docs.git
synced 2024-12-23 03:59:23 +00:00
Merge pull request #36 from CryptoGrampy/master
Fix submodules and add basic MoneroDocs setup guide
This commit is contained in:
commit
4cc3841548
3 changed files with 36 additions and 1 deletions
3
.gitmodules
vendored
Normal file
3
.gitmodules
vendored
Normal file
|
@ -0,0 +1,3 @@
|
|||
[submodule "mkdocs-material"]
|
||||
path = mkdocs-material
|
||||
url = https://github.com/squidfunk/mkdocs-material.git
|
32
README.md
Normal file
32
README.md
Normal file
|
@ -0,0 +1,32 @@
|
|||
# MoneroDocs
|
||||
|
||||
- [MoneroDocs](#monerodocs)
|
||||
- [About](#about)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
## About
|
||||
|
||||
Monerodocs attempts to organize basic technical knowledge on Monero in one place.
|
||||
|
||||
While technical explanations are out there, knowledge is scattered through reddit posts, git comments, stack exchange answers, chat logs and the source code. This makes it hard to find complete and up-to-date explanations on advanced topics.
|
||||
|
||||
The goal is to educate and onboard power users faster.
|
||||
|
||||
## Contributing
|
||||
|
||||
To contribute to MoneroDocs, you'll need to setup your local [Mkdocs-Material](https://squidfunk.github.io/mkdocs-material/) environment:
|
||||
|
||||
```sh
|
||||
# Fork the monerodocs/md Github repo
|
||||
|
||||
# Clone your newly created repo- be sure to include the submodule flag
|
||||
git clone --recurse-submodules git@github.com:your-user-name/md.git
|
||||
|
||||
cd md
|
||||
|
||||
# Install mkdocs dependencies
|
||||
pip install mkdocs-material mkdocs-minify-plugin
|
||||
|
||||
# Run the documentation server locally
|
||||
python3 -m mkdocs serve
|
||||
```
|
|
@ -1 +1 @@
|
|||
Subproject commit 2bab77cf071d2a50b5990667b662708501328e09
|
||||
Subproject commit 9dd23f6926ca5910d4323d87653f4fb3df17369d
|
Loading…
Reference in a new issue