Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 2.24 KB

README.md

File metadata and controls

95 lines (63 loc) · 2.24 KB
Raw

Start9 Documentation

Welcome to the Start9 Docs! Here you will find the StartOS user manual, as well as integration guides, FAQ, support, knowledge base, and developer docs.

Building

  1. Install dependencies

    Rust

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

    mdBook - Documentation framework

    cargo install mdbook

    mdBook-admonish - Admonitions plugin

    cargo install mdbook-admonish

    mdBook-i18n - Internationalization plugin

    cargo install mdbook-i18n

  2. Clone the repo and change into its directory

    git clone https://github.com/Start9Labs/docs.git && cd docs

  3. Serve and view a live, local version of the docs while editing

    mdbook serve --open

    This will automatically open your default web browser and navigate to http://localhost:3000

Contributing

We love contributions! Whether you spot a typo or want to make suggestions, you can fork this project and submit a PR with your changes for consideration. If you are uncomfortable with this process, please create an issue.

If you'd like to get started contributing to open source software, it's easier than you think! Visit one of our Community Channels and we'll help you get started.

Third party plugins

External link to plugins

Possible mdbook admonitions

A note.

An example.

Some info on this thing.

Protip on this thing.

You don't want to do this!

Bonjour sucks, but it's gone now

WTF ARE YOU DOING?!

The following steps can lead to irrecoverable data corruption.

Admonition without title - This will take a while, go and grab a sandwich.

And tons more -> https://tommilligan.github.io/mdbook-admonish/reference.html