README.md

ssg-dj

Installation

Cargo Install

Crates.io

If you have a Rust environment set up, you can install the binary from crates.io with the following command:

cargo install dn-cli

Build From Source

git clone https://github.com/mmibbetson/ssg-dj
cd ssg-dj
just install

Nix

Download From Nixpkgs

In configuration.nix, you can add the package as ssg-dj --- for example:

  users.users.yourUsername = {
    packages = with pkgs; [
      ssg-dj
    ];
  };

Build Derivation

git clone https://github.com/mmibbetson/ssg-dj

You can then add the package in your configuration.nix with the following:

nixpkgs.config.packageOverrides = pkgs: {
  ssg-dj = pkgs.callPackage <route-to-dn-repository>/default.nix { };
};

From there you can install the package as ssg-dj at the system level or user level by including it in your packages.

Quick Start

Extras

Manpages and shell completions are available, they can be installed manually. The supported shells are:

• bash
• zsh
• fish
• powershell
• nushell
• elvish

Editor Support

iu is designed with the intention that it will be integrated into text editors via extensions. When Helix's plugin system is implemented, the intention is to provide an ergonomic set of extensions as specified in the integration docs. A VSCode extension is also being considered.

• Helix
• Visual Studio Code

Inspirations

• Zola
• The Unix Philosophy
• Cold-Blooded Software

Dependencies

Dependencies are relatively minimal. In time, this project will be feature-complete, and enter maintenance mode. A primary concern for dn is to minimise churn and maximise long-term stability. Eventually, all dependencies will be vendored and the program will be considered "finished", outside of necessary bug fixes and/or emergency patches.

Development

• ssg-dj follows Semantic Versioning for version numbering.
• ssg-dj uses Conventional Commits for commit messages.
• ssg-dj is REUSE compliant.