Giter Club home page Giter Club logo

docs's Introduction

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

docs's People

Contributors

13homer13 avatar gstart9 avatar k0gen avatar kn0wmad avatar mattdhill avatar stupleb avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

stupleb 13homer13

docs's Issues

[feat] Docs As A Service

Package up docs as an .s9pk for the Marketplace. This will likely not happen until after the docs refactor.

Updates/versioning would probably follow OS updates

[refactor] Master Refactor Checklist

  • Styling - @elvece

  • Versioning? - @kn0wmad investigating

  • Domains - @elvece

    • docs.start9.com
    • dev-docs.start9.com
    • versioned?
  • CI/CD?

  • Deployment - @elvece

  • Content (Docs) - @kn0wmad and team

    • Introduction

    • User Manual

      • Initial Setup
      • Backup & Restore
        • Cloud
        • Remote
        • Local Network
        • Physical
        • Restore from Backup
          • Restore
          • Attach
          • Recover
          • Transfer
          • Hardware upgrades
      • StartOS Walkthrough
        • Main UI
        • Updates
        • Managing Services
        • Customization
        • Session Management
        • WiFi & Bluetooth
        • SSH
        • Marketplace
          • Managing registries
    • Support

      • FAQ
      • Troubleshooting
        • Initial setup
        • Device connectivity
        • Backups
        • Reset your password
      • Start9 Support
      • External Support
    • Guides

      • DIY
        • X86_64
        • RasPi
        • ARM
      • Device Guides
        • Linux
          • LAN
          • VPN
          • Domains
          • Tor
          • Browser config
        • Mac
          • LAN
          • VPN
          • Domains
          • Tor
          • Browser config
        • Windows
          • LAN
          • VPN
          • Domains
          • Tor
          • Browser config
        • Android
          • LAN
          • VPN
          • Domains
          • Tor
          • Browser config
        • iOS
          • LAN
          • VPN
          • Domains
          • Tor
          • Browser config
      • Service guides
        • Bitcoin
        • Jellyfin
        • Lightning
        • Matrix
        • Nextcloud
        • Specter
        • Vaultwarden
  • Content (Dev docs) - @MattDHill and team

    • Contributing
      • StartOS
      • Service packaging
      • Documentation
    • StartOS Dev Tools
      • startd
      • start-cli
      • start-sdk
    • Package A Service
    • Packaging Spec
    • Submission Process

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.