Skip to content


Repository files navigation

logo Silver Bullet

Sphinx-powered note-taking system of SilverRainZ.

There are some articles describes the architecture of this note-taking system.


Visit (hosted by Github Pages).

For visitors in China, there is a Gitee Pages mirror:

位于中国的访客可以访问 Gitee 镜像:


You MUST have following programs installed:

  • Git
  • GNU make
  • Python>=3.9
  • Sphinx>5

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

Ask sphinx to build HTML documentation:


Root page of the HTML documentation can be found at _build/html/index.html.


Copyright 2020-2024, Shengyu Zhang.

The contents of this repository/documentation are all published under cc-badge Attribution-ShareAlike (CC BY-SA) agreement. For more details, please refer to: LICENSE.