https://github.com/badboy/mdbook-dtmo

Render the Firefox Data Documentation using mdbook
https://github.com/badboy/mdbook-dtmo

Last synced: 9 days ago
JSON representation

Render the Firefox Data Documentation using mdbook

• Host: GitHub
• URL: https://github.com/badboy/mdbook-dtmo
• Owner: badboy
• License: mpl-2.0
• Created: 2018-07-20T10:14:57.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-12-13T10:54:43.000Z (about 1 year ago)
• Last Synced: 2024-12-24T02:01:28.212Z (12 days ago)
• Language: Rust
• Homepage:
• Size: 416 KB
• Stars: 11
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdbook-dtmo

A combination of preprocessors for [mdbook][] to render the [Firefox Data Documentation][dtmo].

[mdbook]: https://github.com/rust-lang-nursery/mdBook

[dtmo]: https://docs.telemetry.mozilla.org/

[gitbook]: https://github.com/GitbookIO/gitbook

## Included preprocessors:

* [mdbook-mermaid][]: add [mermaid.js][] support

* [mdbook-toc][]: add inline ToC support

* [mdbook-open-on-gh][]: add an open-on-github link on every page

[mdbook-mermaid]: https://github.com/badboy/mdbook-mermaid

[mdbook-toc]: https://github.com/badboy/mdbook-toc

[mdbook-open-on-gh]: https://github.com/badboy/mdbook-open-on-gh

[mermaid.js]: https://mermaidjs.github.io/

## Installation

If you want to use this mdbook bundle, install the tool:

```

cargo install mdbook-dtmo

```

Build the book:

```

mdbook-dtmo path/to/firefox-data-docs

```

## License

MPL. See [LICENSE](LICENSE).  

Copyright (c) 2018-2021 Jan-Erik Rediger