Fully structured note-taking system of SilverRainZ.
Powered by Sphinx and Sphinx Notes
.
Visit https://silverrainz.me/.
You MUST have following programs installed:
- Git
- GNU make
- Python>=312
- Sphinx>=8
Install python package dependencies by the following commmands:
pip3 install --user -r requirements.txt
I developed series of sphinx extensions for my note-taking system. You can found them in the requirements.txt:
The following programs are OPTIONAL if you don’t need to build various contents embedded in the documentation:
- Lilypond
- Timidity++
- FFmpeg
- ImageMagick
- Graphviz
- PlantUML
Firstly clone this repository (The repository is quite big,
clone with --depth=1
if you dont want to make any changes):
git clone https://github.com/SilverRainZ/bullet.git
Ask sphinx to build HTML documentation:
make html
Root page of the HTML documentation can be found at build/html/index.html
.
Copyright 2020-2025, Shengyu Zhang.
The contents of this repository/documentation are all published under
Attribution-ShareAlike (CC BY-SA) agreement. For more details,
please refer to: LICENSE.