Skip to content

Start9Labs/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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
    
  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

Releases

No releases published

Packages

No packages published

Contributors 12