Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# We want to ignore our vale StylesPath
.github/vale/*
gqm*[pngmd]
book
46 changes: 46 additions & 0 deletions MDBOOK.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# mdBook

Details about our mdBook setup.

## Installation

To install cargo, run the following command:

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

To install mdBook, run the following command:

```bash
cargo install mdbook
```

## Usage

To build the book, run the following command:

```bash
mdbook build
```

To serve the book, run the following command:

```bash
npx serve book -p 3000
```

## Configuration

The configuration file is located at `book.toml`.

We've enabled the following features:

* **Giscus**: To enable comments on the book. See [mdbook-embedify](https://mr-addict.github.io/mdbook-embedify/third-party/giscus.html) for more details.
* **Mermaid**: To enable diagrams in the book. See [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid) for more details.

## Deployment

TBD

See: <https://github.com/rust-lang/mdBook/blob/master/.github/workflows/deploy.yml>
28 changes: 28 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[book]
authors = ["InnerSource Commons"]
language = "en"
multilingual = false
src = "."
title = "How To Create An InnerSource Program Office"

[preprocessor]

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

[preprocessor.embedify]
giscus.enable = true
giscus.repo = "InnerSourceCommons/managing-innersource-projects"
giscus.repo-id = "MDEwOlJlcG9zaXRvcnk4MjY2ODc3OA=="
giscus.category = "Website"
giscus.category-id = "DIC_kwDOBO1s6s4CiMTg"
giscus.reactions-enabled = "1"
giscus.theme = "preferred_color_scheme"
giscus.lang = "en"
giscus.loading = "eager"
giscus.crossorigin = "anonymous"

[output]

[output.html]
additional-js = ["mermaid.min.js", "mermaid-init.js"]
1 change: 1 addition & 0 deletions 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 mermaid.min.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions use_gqm/goals/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Goals
1 change: 1 addition & 0 deletions use_gqm/metrics/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Metrics
1 change: 1 addition & 0 deletions use_gqm/questions/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Questions