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
- uv
Python (>=3.14) and python package dependencies (including Sphinx>=9.1) are managed by uv, install them by the following commmands:
uv sync
I developed series of sphinx extensions for my note-taking system. You can found them in the pyproject.toml:
The following programs are OPTIONAL if you don’t need to build various contents embedded in the documentation:
- Lilypond
- Timidity++
- FFmpeg
- ImageMagick
- Graphviz
- PlantUML
- A CJK font (such as fonts-noto-cjk)
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
