Skip to content

Commit

Permalink
doc: Port back to Emanote
Browse files Browse the repository at this point in the history
  • Loading branch information
srid committed Jan 23, 2024
1 parent 8767f38 commit 7aff11c
Show file tree
Hide file tree
Showing 5 changed files with 353 additions and 6 deletions.
284 changes: 284 additions & 0 deletions doc/flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 36 additions & 0 deletions doc/flake.nix
Original file line number Diff line number Diff line change
@@ -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;
};
};
}
14 changes: 8 additions & 6 deletions doc/index.md → doc/mission-control.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
24 changes: 24 additions & 0 deletions doc/mission-control.yaml
Original file line number Diff line number Diff line change
@@ -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: |
<snippet var="js.highlightjs" />
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
1 change: 1 addition & 0 deletions flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
dev = {
dir = "./dev";
};
doc.dir = "./doc";
};
};
}

0 comments on commit 7aff11c

Please sign in to comment.