An AsciiDoc[tor]-powered wiki of sorts.
Install the dependencies:
$ cd ./adocwiki
$ gem install bundler
$ bundle install
Then, go to your wiki/docs directory:
$ cd path/to/docs/with/nav.yml
$ ruby path/to/adocwiki/src/main.rb $PWD
Then run some webserver in the ./build/
directory.
Python3 has a nice quicky and easy http module:
$ python3 -m http.server -b localhost 3001
Serving HTTP on ::1 port 3001 (http://[::1]:3001/) ...
Then, open the browser at localhost:3001.
Note
|
The commands below is a temporary workaround until a better, more automated approach is implemented. |
On every AsciiDoc file, set the imagesdir
attribute to assets
and make sure to create a directory assets
as a sibling of the document which will include those assets.
Then include the image like this:
= Document Title
:icons: font
:sectlinks:
:sectlevels: 6
:imagesdir: __assets
== Intro
Intro text...
image:my-image.png[Alt text]
After building (converting to HTML) the documents, copy the assets to each sub-directory inside the build/
directory accordingly (assumes bash >= 4):
assets_dir=($(find ./docs -type d -name __assets -print))
for asset_dir in "${assets_dir[@]}"
do
cp -rv "$asset_dir" "${asset_dir/docs/build}"
done
Favicon based on this free terminal icon:
Hamburger outline menu icon:
Close icon: