https://github.com/toyboot4e/adbook
Dead-simple SSG powered by Asciidoctor
https://github.com/toyboot4e/adbook
Last synced: over 1 year ago
JSON representation
Dead-simple SSG powered by Asciidoctor
- Host: GitHub
- URL: https://github.com/toyboot4e/adbook
- Owner: toyboot4e
- License: mit
- Created: 2020-10-07T14:23:14.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-16T13:37:41.000Z (about 4 years ago)
- Last Synced: 2025-03-15T23:28:32.895Z (over 1 year ago)
- Language: Rust
- Homepage: https://toyboot4e.github.io/adbook/
- Size: 1.11 MB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# adbook
`adbook` is a tool for building book-like web pages
The name came from [mdBook](https://rust-lang.github.io/mdBook/).
## Demo
A demo site is avaiable [here](https://toyboot4e.github.io/adbook/).
The source files of the demo is [here](https://github.com/toyboot4e/adbook/tree/gh-pages).
## Installation
### Rust & adbook
After installing [Rust](https://www.rust-lang.org/), `adbook` is avaiable via crates.io:
```sh
$ cargo install adbook # -> `$HOME/.cargo/bin`
```
> Make sure `$HOME/.cargo/bin` is added to your `PATH`
### Ruby, Asciidoctor and Asciidoctor extensions
You need [Ruby](https://www.ruby-lang.org/en/) and some package manager. I'd recommend [RVM](https://rvm.io/).
[asciidoctor](https://asciidoctor.org) and [asciidoctor-diagram](https://asciidoctor.org/docs/asciidoctor-diagram/) can be installed as gems:
```sh
$ gem install asciidoctor
$ gem install asciidoctor-diagram
```