Silver Bullet
Sphinx-powered note-taking system of SilverRainZ.
There is an article describes the architecture of this note-taking system from a technical level.
Browse
Visit https://silverrainz.me/ (hosted by Github Pages).
For visitors in China, there is a Gitee Pages mirror: https://silverrainz.gitee.io/
Dependencies
You must have following programs installed:
- Git
- GNU make
- Python3
- Sphinx>3.0
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:
sphinxnotes-any  : | Use reST directive to record and refer anything. For example, the paintings I have drawn, the books I have read. |
|---|---|
sphinxnotes-snippet  : | This extension allows me access reST documents from vim or terminal in extremely fast speed . |
sphinxnotes-lilypond  : | For rendering my musical scores. |
sphinxnotes-isso  : | Embeding Isso comments in reST documents. |
sphinxnotes-strike  : | Add HTML strikethrough text support. |
To build various contents embeded in the documents, the following programs are optional if you don’t need to view these contents:
- Lilypond
- Timidity++
- FFmpeg
- ImageMagick
- Graphviz
- PlantUML
Build
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
Root page of the HTML documentation can be found at _build/html/index.html.
LICENSE
Copyright 2020-2021, Shengyu Zhang.
The contents of this repository/documentation are all published under 