Merge pull request #1019 from dsalaza4/main

feat(build): #940 use mkdocs

.github/workflows/prod.yml

@@ -180,7 +180,7 @@ jobs:
           full_commit_message: ${{ github.event.head_commit.message }}
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_branch: docs
-          publish_dir: docs/book
+          publish_dir: docs/site
           user_name: github-actions[bot]
           user_email: github-actions[bot]@users.noreply.github.com
 

docs/.gitignore

@@ -1,2 +1 @@
-/book
-/mermaid.min.js
+/site

docs/mkdocs.yml

@@ -0,0 +1,18 @@
+site_name: Makes Documentation
+site_url: https://fluidattacks.github.io/makes/
+site_description: Documentation for Makes
+site_author: Fluid Attacks
+repo_url: https://github.com/fluidattacks/makes
+repo_name: Makes
+copyright: Copyright © 2023 Fluid Attacks, We hack your software. All rights reserved.
+
+docs_dir: src
+strict: true
+theme:
+  name: material
+markdown_extensions:
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format

makes.nix

@@ -63,8 +63,6 @@
     makes = {
       bin = [
         inputs.nixpkgs.just
-        inputs.nixpkgs.mdbook
-        inputs.nixpkgs.mdbook-mermaid
         inputs.nixpkgs.reuse
       ];
       source = [outputs."/cli/env/runtime"];

makes/docs/dev/entrypoint.sh

@@ -1,4 +1,7 @@
 # shellcheck shell=bash
 
-mdbook-mermaid install docs/
-mdbook serve docs
+function main {
+  mkdocs serve -f docs/mkdocs.yml
+}
+
+main "${@}"

makes/docs/dev/main.nix

@@ -1,13 +1,10 @@
 {
-  inputs,
   makeScript,
+  outputs,
   ...
 }:
 makeScript {
   name = "docs-dev";
   entrypoint = ./entrypoint.sh;
-  searchPaths.bin = [
-    inputs.nixpkgs.mdbook
-    inputs.nixpkgs.mdbook-mermaid
-  ];
+  searchPaths.source = [outputs."/docs/runtime"];
 }

makes/docs/entrypoint.sh

@@ -1,4 +1,7 @@
 # shellcheck shell=bash
 
-mdbook-mermaid install docs/
-mdbook build docs
+function main {
+  mkdocs build -f docs/mkdocs.yml
+}
+
+main "${@}"

makes/docs/main.nix

@@ -1,13 +1,10 @@
 {
-  inputs,
   makeScript,
+  outputs,
   ...
 }:
 makeScript {
   name = "docs";
   entrypoint = ./entrypoint.sh;
-  searchPaths.bin = [
-    inputs.nixpkgs.mdbook
-    inputs.nixpkgs.mdbook-mermaid
-  ];
+  searchPaths.source = [outputs."/docs/runtime"];
 }

makes/docs/runtime/main.nix

@@ -0,0 +1,15 @@
+{
+  inputs,
+  makePythonPypiEnvironment,
+  makeSearchPaths,
+  ...
+}:
+makeSearchPaths {
+  bin = [inputs.nixpkgs.mkdocs];
+  source = [
+    (makePythonPypiEnvironment {
+      name = "docs-runtime-pypi";
+      sourcesYaml = ./pypi/sources.yaml;
+    })
+  ];
+}

makes/docs/runtime/pypi/deps.yaml

@@ -0,0 +1 @@
+mkdocs-material: "9.1.1"