diff options
| author | Irene Knapp <ireneista@internetsafetylabs.org> | 2025-10-09 22:46:34 -0700 |
|---|---|---|
| committer | Irene Knapp <ireneista@internetsafetylabs.org> | 2025-10-09 22:46:34 -0700 |
| commit | aad528d1b211e64ffe3f5688c141d442d7fa081a (patch) | |
| tree | be540be0b22bc1d5cc65445c3765d80f3bc86238 | |
| parent | 1dc89b551ae3c973e590112c49272132fde12810 (diff) | |
add a skeleton for documentation
Change-Id: I528864e13c4b318dd70a004b8c2029831863c37c
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | docs/css/smalltech.css | 63 | ||||
| -rw-r--r-- | docs/index.md | 3 | ||||
| -rw-r--r-- | flake.nix | 31 | ||||
| -rw-r--r-- | mkdocs.yml | 5 |
5 files changed, 99 insertions, 4 deletions
diff --git a/.gitignore b/.gitignore index c4d7ee0..bf713a7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ result +/site *.swp .direnv .DS_Store diff --git a/docs/css/smalltech.css b/docs/css/smalltech.css new file mode 100644 index 0000000..ce33740 --- /dev/null +++ b/docs/css/smalltech.css @@ -0,0 +1,63 @@ +@font-face { + font-family: 'Raleway'; + font-style: normal; + font-weight: 125 950; + src: url(/css/fonts/Raleway-VariableFont_wght.ttf); +} + +@font-face { + font-family: 'Poppins'; + font-style: normal; + font-weight: 600; + src: url(/css/fonts/Poppins-SemiBold.ttf); +} + +@font-face { + font-family: 'Harmonia Sans Pro'; + font-style: normal; + font-weight: 600; + src: url(/css/fonts/HarmoniaSansProCyr-Regular.ttf); +} + +@font-face { + font-family: 'Harmonia Sans Pro'; + font-style: normal; + font-weight: bold; + src: url(/css/fonts/HarmoniaSansProCyr-Bold.ttf); +} + + +body { + font-family: 'Raleway'; +} + +.wy-menu, h1, h2, h3, h4, h5, h6 { + font-family: 'Poppins'; +} + +.rst-versions, .btn { + font-family: 'Harmonia Sans Pro', sans-serif; +} + +.wy-side-nav-search, .wy-nav-top { + background-color: #6700be; +} + +.wy-nav-side { + background-color: #dadbdc; +} + +.wy-menu-vertical a { + color: #757679; +} + +.wy-menu-vertical header, +.wy-menu-vertical p.caption { + color: #6700be; +} + +.rst-content code { + color: #757679; + border-radius: 5px; +} + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..81a3b1d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Welcome! + +TODO a sentiment here to ground this experience and set the tone would be great. diff --git a/flake.nix b/flake.nix index f495553..896a587 100644 --- a/flake.nix +++ b/flake.nix @@ -10,8 +10,9 @@ outputs = { self, nixpkgs, ... }@attrs: let supportedSystems = [ "aarch64-linux" "x86_64-linux" ]; - forAllSystems = nixpkgs.lib.genAttrs supportedSystems; - nixpkgsFor = forAllSystems (system: import nixpkgs { inherit system; }); + forAllPkgs = f: + nixpkgs.lib.genAttrs supportedSystems + (system: f (import nixpkgs { inherit system; })); in { nixosModules.default = { ... }: { imports = [ @@ -26,9 +27,31 @@ ]; }; - devShells = forAllSystems (system: let pkgs = nixpkgsFor.${system}; in { + packages = forAllPkgs (pkgs: { + documentation = pkgs.stdenv.mkDerivation rec { + name = "smalltech-documentation"; + version = "1.0"; + + src = ./.; + + nativeBuildInputs = with pkgs; [ mkdocs ]; + + buildPhase = '' + ls -al + ${pkgs.mkdocs}/bin/mkdocs build -f docs/mkdocs.yml + ''; + + installPhase = '' + rm $out/mkdocs.yml + ''; + }; + }); + + devShells = forAllPkgs (pkgs: { default = pkgs.mkShell { - buildInputs = with pkgs; [ ]; + buildInputs = with pkgs; [ + mkdocs + ]; }; }); }; diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..5f034e7 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,5 @@ +site_name: Smalltech Manual +theme: readthedocs +extra_css: + - css/smalltech.css + |