Docki

Note

This project is under renovations. While installing it right now might work, it is not guaranteed

Preview

Docki is cli for converting asciidoctor files into html files. You can build your documentation with docki build and write documenation using the live server with docki serve.

Installation

Nix

This installation method is recommended, because it will include both asciidoctor and asciidoctor_revealjs.

Note: This is the most basic installation. If you are already more experienced, you might want to add it to your shell or home manager configuration.

nix profile install github:quirinecker/docki

Homebrew

Note

Installing it via homebrew will not include asciidoctor_revealjs. It can be installed afterwards with docki install-reveal

brew tap quirinecker/docki-homebrew https://github.com/quirinecker/docki-homebrew

brew install docki

Cargo

Note

This is the most basic installation. It will not include asciidoctor_revealjs and asciidoctor itself. Installing asciidoctor has to be done manually, while installing asciidoctor_revealjs can be done with docki install-reveal

cargo install docki

Nix (Advanced, Flake)

Note

There are multiple ways to install docki with nix. This is the way I installed it on my machine.

1. Add it to the flake inputs

docki = {
	url = "github:quirinecker/docki";
	inputs.nixpkgs.follows = "nixpkgs";
};

2. Add @inputs at the end of the outputs (if you haven't already)

outputs = {
	nixpkgs
	...
}@inputs:
...Rest of your flake...

3. Add the input to your system packages (system configuration) or home packages (home manager configuration)

environment.systemPackages = with pkgs; [
	inputs.docki.packages.${system}.default
]

or

home.packages = with pkgs; [
	inputs.docki.packages.${system}.default
]