Skip to content

README.md

Latest commit

 

History

History
69 lines (43 loc) · 1.42 KB

README.md

File metadata and controls

69 lines (43 loc) · 1.42 KB

Solar Network Documentation

https://docs.solar.org

Solar Network Documentation made with MkDocs Material

Requirements

  • Python >= 3.6

Some Debian/Ubuntu systems may need to install python3-venv:
e.g., apt install python3.10-venv

Installation

Solar Network documentation development utilises Python venv:

1: Create the Python Virtual Environment and install dependencies

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
Later on, you can exit the virtual environment using the 'deactivate' command. 
deactivate

2: Serve locally

mkdocs serve

Then visit: http://127.0.0.1:8000

3: Deploy to GH Pages

(admins-only) 
mkdocs build
mkdocs gh-deploy --force

Security

If you discover a security vulnerability within any of these packages, please send an e-mail to security@solar.org. All security vulnerabilities will be promptly addressed.

Credits

This project exists thanks to all the people who contribute.

License

Please read the separate LICENSE file for details.