From 7aff11c21bd7b2045fdd90e6d0a1c714e96020d4 Mon Sep 17 00:00:00 2001 From: Sridhar Ratnakumar Date: Tue, 23 Jan 2024 09:34:06 +0530 Subject: [PATCH] doc: Port back to Emanote --- doc/flake.lock | 284 +++++++++++++++++++++++++++ doc/flake.nix | 36 ++++ doc/{index.md => mission-control.md} | 14 +- doc/mission-control.yaml | 24 +++ flake.nix | 1 + 5 files changed, 353 insertions(+), 6 deletions(-) create mode 100644 doc/flake.lock create mode 100644 doc/flake.nix rename doc/{index.md => mission-control.md} (90%) create mode 100644 doc/mission-control.yaml diff --git a/doc/flake.lock b/doc/flake.lock new file mode 100644 index 0000000..8aec380 --- /dev/null +++ b/doc/flake.lock @@ -0,0 +1,284 @@ +{ + "nodes": { + "commonmark-simple": { + "flake": false, + "locked": { + "lastModified": 1705078713, + "narHash": "sha256-YgDHJG8M47ZXGLWu8o7MhXbIrgQ0Ai32Gr8nKvZGGw8=", + "owner": "srid", + "repo": "commonmark-simple", + "rev": "fc106c94f781f6a35ef66900880edc08cbe3b034", + "type": "github" + }, + "original": { + "owner": "srid", + "repo": "commonmark-simple", + "type": "github" + } + }, + "commonmark-wikilink": { + "flake": false, + "locked": { + "lastModified": 1705502834, + "narHash": "sha256-79fzI4fPhCkfusDXctQwwmjIcWMrLfTvUtKBY32asuM=", + "owner": "srid", + "repo": "commonmark-wikilink", + "rev": "f6d7bdf7f1fce09ba2a4259b0306b0eef24c0cf7", + "type": "github" + }, + "original": { + "owner": "srid", + "repo": "commonmark-wikilink", + "type": "github" + } + }, + "ema": { + "inputs": { + "flake-parts": [ + "emanote", + "flake-parts" + ], + "flake-root": [ + "emanote", + "flake-root" + ], + "haskell-flake": [ + "emanote", + "haskell-flake" + ], + "nixpkgs": [ + "emanote", + "nixpkgs" + ], + "treefmt-nix": [ + "emanote", + "treefmt-nix" + ] + }, + "locked": { + "lastModified": 1702334080, + "narHash": "sha256-zrtzyLrSORxtocLMji5U9p4pDicMulOqgsuiB4LCu1o=", + "owner": "srid", + "repo": "ema", + "rev": "33f4cf31ace7e612e78ad25f5fc45089745ab644", + "type": "github" + }, + "original": { + "owner": "srid", + "ref": "no-ws", + "repo": "ema", + "type": "github" + } + }, + "emanote": { + "inputs": { + "commonmark-simple": "commonmark-simple", + "commonmark-wikilink": "commonmark-wikilink", + "ema": "ema", + "emanote-template": "emanote-template", + "flake-parts": "flake-parts", + "flake-root": "flake-root", + "haskell-flake": "haskell-flake", + "heist-extra": "heist-extra", + "nixpkgs": "nixpkgs", + "systems": "systems", + "treefmt-nix": "treefmt-nix", + "unionmount": "unionmount" + }, + "locked": { + "lastModified": 1705667811, + "narHash": "sha256-ZH/m5e4l4v2HRcv45trQKl92PRG6e1lpRJ4+U4zewL8=", + "owner": "srid", + "repo": "emanote", + "rev": "bf573e7653d183baa0fa68e2e172333f585b7a25", + "type": "github" + }, + "original": { + "owner": "srid", + "repo": "emanote", + "type": "github" + } + }, + "emanote-template": { + "flake": false, + "locked": { + "lastModified": 1703877265, + "narHash": "sha256-2xdikzzHrIHr1s2pAJrBJU8mZP258Na3V4P4RWteDZM=", + "owner": "srid", + "repo": "emanote-template", + "rev": "9d458b63c80162519ae55814e60f17cc9d3f95a3", + "type": "github" + }, + "original": { + "owner": "srid", + "repo": "emanote-template", + "type": "github" + } + }, + "flake-parts": { + "inputs": { + "nixpkgs-lib": "nixpkgs-lib" + }, + "locked": { + "lastModified": 1704982712, + "narHash": "sha256-2Ptt+9h8dczgle2Oo6z5ni5rt/uLMG47UFTR1ry/wgg=", + "owner": "hercules-ci", + "repo": "flake-parts", + "rev": "07f6395285469419cf9d078f59b5b49993198c00", + "type": "github" + }, + "original": { + "owner": "hercules-ci", + "repo": "flake-parts", + "type": "github" + } + }, + "flake-root": { + "locked": { + "lastModified": 1692742795, + "narHash": "sha256-f+Y0YhVCIJ06LemO+3Xx00lIcqQxSKJHXT/yk1RTKxw=", + "owner": "srid", + "repo": "flake-root", + "rev": "d9a70d9c7a5fd7f3258ccf48da9335e9b47c3937", + "type": "github" + }, + "original": { + "owner": "srid", + "repo": "flake-root", + "type": "github" + } + }, + "haskell-flake": { + "locked": { + "lastModified": 1705067885, + "narHash": "sha256-al2JqNIkXfLiVreqSJWly64Z6YVNphWBh4m3IxGIdYI=", + "owner": "srid", + "repo": "haskell-flake", + "rev": "8a526aaf98cde6af6b2d1d368e9acb460ee34547", + "type": "github" + }, + "original": { + "owner": "srid", + "repo": "haskell-flake", + "type": "github" + } + }, + "heist-extra": { + "flake": false, + "locked": { + "lastModified": 1691619499, + "narHash": "sha256-4e8v5t4FM99pdcPhohP3dAeGtsFnirbfYGpbr2+qWxI=", + "owner": "srid", + "repo": "heist-extra", + "rev": "54ff970f733dd45b5509d1c4c298927b6241041b", + "type": "github" + }, + "original": { + "owner": "srid", + "repo": "heist-extra", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1704842529, + "narHash": "sha256-OTeQA+F8d/Evad33JMfuXC89VMetQbsU4qcaePchGr4=", + "owner": "nixos", + "repo": "nixpkgs", + "rev": "eabe8d3eface69f5bb16c18f8662a702f50c20d5", + "type": "github" + }, + "original": { + "owner": "nixos", + "ref": "nixpkgs-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs-lib": { + "locked": { + "dir": "lib", + "lastModified": 1703961334, + "narHash": "sha256-M1mV/Cq+pgjk0rt6VxoyyD+O8cOUiai8t9Q6Yyq4noY=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "b0d36bd0a420ecee3bc916c91886caca87c894e9", + "type": "github" + }, + "original": { + "dir": "lib", + "owner": "NixOS", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "emanote": "emanote", + "flake-parts": [ + "emanote", + "flake-parts" + ], + "nixpkgs": [ + "emanote", + "nixpkgs" + ] + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + }, + "treefmt-nix": { + "inputs": { + "nixpkgs": [ + "emanote", + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1693468138, + "narHash": "sha256-DddblCahuTW8K0ncPOheTlG3igE8b15LJjafF1PWhOo=", + "owner": "numtide", + "repo": "treefmt-nix", + "rev": "6930a5ba0a722385baf273885a03f561dcb1af67", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "treefmt-nix", + "type": "github" + } + }, + "unionmount": { + "flake": false, + "locked": { + "lastModified": 1691619410, + "narHash": "sha256-V9/OcGu9cy4kV9jta12A6w5BEj8awSEVYrXPpg8YckQ=", + "owner": "srid", + "repo": "unionmount", + "rev": "ed73b627f88c8f021f41ba4b518ba41beff9df42", + "type": "github" + }, + "original": { + "owner": "srid", + "repo": "unionmount", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/doc/flake.nix b/doc/flake.nix new file mode 100644 index 0000000..7fce5e3 --- /dev/null +++ b/doc/flake.nix @@ -0,0 +1,36 @@ +{ + nixConfig = { + extra-substituters = "https://srid.cachix.org"; + extra-trusted-public-keys = "srid.cachix.org-1:3clnql5gjbJNEvhA/WQp7nrZlBptwpXnUk6JAv8aB2M="; + }; + + inputs = { + emanote.url = "github:srid/emanote"; + nixpkgs.follows = "emanote/nixpkgs"; + flake-parts.follows = "emanote/flake-parts"; + }; + + outputs = inputs@{ self, flake-parts, nixpkgs, ... }: + flake-parts.lib.mkFlake { inherit inputs; } { + systems = nixpkgs.lib.systems.flakeExposed; + imports = [ inputs.emanote.flakeModule ]; + perSystem = { self', pkgs, system, ... }: { + emanote = { + # By default, the 'emanote' flake input is used. + # package = inputs.emanote.packages.${system}.default; + sites."default" = { + layers = [ ./. ]; + layersString = [ "." ]; + port = 8181; + prettyUrls = true; + }; + }; + devShells.default = pkgs.mkShell { + buildInputs = [ + pkgs.nixpkgs-fmt + ]; + }; + formatter = pkgs.nixpkgs-fmt; + }; + }; +} diff --git a/doc/index.md b/doc/mission-control.md similarity index 90% rename from doc/index.md rename to doc/mission-control.md index a8de062..31b73e7 100644 --- a/doc/index.md +++ b/doc/mission-control.md @@ -1,14 +1,16 @@ --- -slug: /mission-control -sidebar_label: Scripts -sidebar_position: 2 +short-title: mission-control +template: + sidebar: + collapsed: true +emanote: + folder-folgezettel: false --- # Devshell scripts using `mission-control` -:::info Note -As a simpler alternative to `mission-control`, you may also use [just](https://just.systems/man/en/) (see [example use](https://github.com/srid/haskell-template/pull/111)). -::: +>[!info] Alternative +> As a simpler alternative to `mission-control`, you may also use [just](https://just.systems/man/en/) (see [example use](https://github.com/srid/haskell-template/pull/111)). The [mission-control](https://github.com/Platonic-Systems/mission-control) flake-parts module enables creating a set of scripts or commands to run in the Nix dev shell. This makes it possible for the project's user to locate all of the commands they need (to get started) in one place, often replacing the likes of `Makefile` or `bin/` scripts. diff --git a/doc/mission-control.yaml b/doc/mission-control.yaml new file mode 100644 index 0000000..59ead0e --- /dev/null +++ b/doc/mission-control.yaml @@ -0,0 +1,24 @@ +# For documentation and available settings, see +# https://github.com/srid/emanote/blob/master/emanote/default/index.yaml + +page: + siteTitle: mission-control + headHtml: | + + +template: + # You can add your own variables here, like editBaseUrl. + # See after-note.tpl to see where editBaseUrl gets used. + editBaseUrl: https://github.com/Platonic-Systems/mission-control/edit/main/doc + + # Uncomment this to get neuron-style pages + # name: /templates/layouts/note + # layout: + # note: + # containerClass: container mx-auto max-w-screen-lg + + sidebar: + collapsed: false + + # If you are hosting on GitLab Pages, you may want to remove this. + urlStrategy: pretty diff --git a/flake.nix b/flake.nix index 458547b..cc81288 100644 --- a/flake.nix +++ b/flake.nix @@ -17,6 +17,7 @@ dev = { dir = "./dev"; }; + doc.dir = "./doc"; }; }; }