Skip to content

Host Docs on Subdomain with mdBook #252

@rtkay123

Description

@rtkay123

There's this tool : https://github.com/rust-lang/mdBook

It renders markdown as HTML:
It also has support for preprocessors like mermaid and plantuml and such. But basically, the deployment is one binary, less than 5mb in size from the latest release at the time of writing (https://github.com/rust-lang/mdBook/releases/tag/v0.4.52).

The idea is to maybe add a docs.tazama.org subdomain which renders the docs here (which we already conveniently have in markdown)?.

Then updates could be handled by CI to update the mdbook when pushed to dev or main?

This is what rendering it looks like:

https://rust-lang.github.io/mdBook/

That book is all markdown files, organised into chapters.

The end goal could look something like:

  • Community -> docs.tazama.org/community
  • Guides -> docs.tazama.org/guides
  • Knowledge-Articles -> docs.tazama.org/knowledge-articles
  • Product -> docs.tazama.org/product
  • Research-Articles -> docs.tazama.org/research-articles
  • Technical -> docs.tazama.org/technical

Where the nested files are chapters of each book.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions