quirinecker/docki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated installation options

Browse Source
This commit is contained in:
quirinecker
2025-10-23 21:14:47 +02:00
parent 4a2f852f30
commit bb098ce77e
1 changed files with 46 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@@ -14,7 +14,7 @@ Docki is cli for converting asciidoctor files into html files. You can build you
### Nix ### Nix
This installation method is recommended, becuase it is the most maintained due to me using nix in development. 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. 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.
@@ -24,8 +24,11 @@ nix profile install github:quirinecker/docki
### Homebrew ### 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://gitlab.com/quirinecker/docki-homebrew brew tap quirinecker/docki-homebrew https://github.com/quirinecker/docki-homebrew
``` ```
``` ```
@@ -34,9 +37,50 @@ brew install docki
### Cargo ### 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`
```shell ```shell
cargo install docki 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
```nix
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)
```nix
environment.systemPackages = with pkgs; [
inputs.docki.packages.${system}.default
]
```
or
```nix
home.packages = with pkgs; [
inputs.docki.packages.${system}.default
]
```