README.md

Aurum Documention & Wiki

Edit required environments

• zola
• git

Initialization steps

Synchronize git submodules

$ git clone --recurse-submodules https://github.com/Shadowsokcs-NET/Aurum-Docs.git

Local editing and preview

$ cd ./Aurum-Docs
$ zola serve
Building site...
Checking all internal links with anchors.
> Successfully checked 0 internal link(s) with anchors.
-> Creating 1 pages (0 orphan), 3 sections, and processing 0 images
Done in 1.3s.

Listening for changes in ./Aurum-Docs/config.toml, content, sass, static, themes}
Press Ctrl+C to stop

Web server is available at http://127.0.0.1:1111

Publish

The github action will automatically built from the main branch to the gh-page branch and finally published on our website shadowsocks-net.github.io/Aurum-Docs.