Skip to content

Commit 7aff11c

Browse files
committed
doc: Port back to Emanote
1 parent 8767f38 commit 7aff11c

File tree

5 files changed

+353
-6
lines changed

5 files changed

+353
-6
lines changed

doc/flake.lock

+284
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/flake.nix

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
nixConfig = {
3+
extra-substituters = "https://srid.cachix.org";
4+
extra-trusted-public-keys = "srid.cachix.org-1:3clnql5gjbJNEvhA/WQp7nrZlBptwpXnUk6JAv8aB2M=";
5+
};
6+
7+
inputs = {
8+
emanote.url = "github:srid/emanote";
9+
nixpkgs.follows = "emanote/nixpkgs";
10+
flake-parts.follows = "emanote/flake-parts";
11+
};
12+
13+
outputs = inputs@{ self, flake-parts, nixpkgs, ... }:
14+
flake-parts.lib.mkFlake { inherit inputs; } {
15+
systems = nixpkgs.lib.systems.flakeExposed;
16+
imports = [ inputs.emanote.flakeModule ];
17+
perSystem = { self', pkgs, system, ... }: {
18+
emanote = {
19+
# By default, the 'emanote' flake input is used.
20+
# package = inputs.emanote.packages.${system}.default;
21+
sites."default" = {
22+
layers = [ ./. ];
23+
layersString = [ "." ];
24+
port = 8181;
25+
prettyUrls = true;
26+
};
27+
};
28+
devShells.default = pkgs.mkShell {
29+
buildInputs = [
30+
pkgs.nixpkgs-fmt
31+
];
32+
};
33+
formatter = pkgs.nixpkgs-fmt;
34+
};
35+
};
36+
}

doc/index.md doc/mission-control.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
---
2-
slug: /mission-control
3-
sidebar_label: Scripts
4-
sidebar_position: 2
2+
short-title: mission-control
3+
template:
4+
sidebar:
5+
collapsed: true
6+
emanote:
7+
folder-folgezettel: false
58
---
69

710
# Devshell scripts using `mission-control`
811

9-
:::info Note
10-
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)).
11-
:::
12+
>[!info] Alternative
13+
> 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)).
1214
1315
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.
1416

doc/mission-control.yaml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# For documentation and available settings, see
2+
# https://github.com/srid/emanote/blob/master/emanote/default/index.yaml
3+
4+
page:
5+
siteTitle: mission-control
6+
headHtml: |
7+
<snippet var="js.highlightjs" />
8+
9+
template:
10+
# You can add your own variables here, like editBaseUrl.
11+
# See after-note.tpl to see where editBaseUrl gets used.
12+
editBaseUrl: https://github.com/Platonic-Systems/mission-control/edit/main/doc
13+
14+
# Uncomment this to get neuron-style pages
15+
# name: /templates/layouts/note
16+
# layout:
17+
# note:
18+
# containerClass: container mx-auto max-w-screen-lg
19+
20+
sidebar:
21+
collapsed: false
22+
23+
# If you are hosting on GitLab Pages, you may want to remove this.
24+
urlStrategy: pretty

flake.nix

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
dev = {
1818
dir = "./dev";
1919
};
20+
doc.dir = "./doc";
2021
};
2122
};
2223
}

0 commit comments

Comments
 (0)