Skip to content

Commit

Permalink
feat(ci): build mdbook
Browse files Browse the repository at this point in the history
  • Loading branch information
TheButlah committed Dec 13, 2024
1 parent e95733f commit a3eab53
Show file tree
Hide file tree
Showing 8 changed files with 1,683 additions and 1 deletion.
10 changes: 10 additions & 0 deletions .github/workflows/book.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: mdbook
on:
pull_request:
push: main

jobs:
build:
runs-on: ubuntu-24.04
steps:
- run: mdbook build docs
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,4 @@ my-config.toml
**/msbuild.err
**/msbuild.wrn

/docs/book/
16 changes: 16 additions & 0 deletions docs/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
[book]
authors = ["Ryan Butler"]
language = "en"
multilingual = false
src = "src"
title = "NexusSocial Decentralized Identity"

[preprocessor]

[preprocessor.mermaid]
command = "mdbook-mermaid"

[output]

[output.html]
additional-js = ["mermaid.min.js", "mermaid-init.js"]
1 change: 1 addition & 0 deletions docs/mermaid-init.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mermaid.initialize({startOnLoad:true});
1,648 changes: 1,648 additions & 0 deletions docs/mermaid.min.js

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Summary

- [Chapter 1](./chapter_1.md)
1 change: 1 addition & 0 deletions docs/src/chapter_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Chapter 1
4 changes: 3 additions & 1 deletion nix/devShells.nix
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ in
default = pkgs.mkShell {
# These programs be available to the dev shell
buildInputs = (with pkgs; [
nixpkgs-fmt
cargo-deny
dotnetCorePackages.sdk_9_0
mdbook
mdbook-mermaid
nixpkgs-fmt
]) ++ pkgs.lib.optional pkgs.stdenv.isDarwin [
pkgs.libiconv
] ++ [
Expand Down

0 comments on commit a3eab53

Please sign in to comment.