https://github.com/shadowsocks-net/aurum-docs
Documentation site of Aurum.NET
https://github.com/shadowsocks-net/aurum-docs
Last synced: 5 months ago
JSON representation
Documentation site of Aurum.NET
- Host: GitHub
- URL: https://github.com/shadowsocks-net/aurum-docs
- Owner: Shadowsocks-NET
- Created: 2021-10-30T12:13:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-05-14T08:07:54.000Z (about 3 years ago)
- Last Synced: 2025-02-07T15:23:40.109Z (over 1 year ago)
- Language: SCSS
- Size: 1.16 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Aurum Documention & Wiki
[](https://github.com/Shadowsocks-NET/Aurum-Docs/actions/workflows/gh_page.yaml)
## Edit required environments
- [zola](https://github.com/getzola/zola)
- [git](https://github.com/git/git)
## Initialization steps
### Synchronize git submodules
```shell
$ git clone --recurse-submodules https://github.com/Shadowsokcs-NET/Aurum-Docs.git
```
### Local editing and preview
```shell
$ 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](https://shadowsocks-net.github.io/Aurum-Docs).