Skip to content

Commit

Permalink
major overhaul, user manual complete
Browse files Browse the repository at this point in the history
  • Loading branch information
MattDHill committed Apr 9, 2024
1 parent c55e2e1 commit 2514852
Show file tree
Hide file tree
Showing 192 changed files with 935 additions and 385 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
book/
book/
.DS_Store
104 changes: 74 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,86 @@
# 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 from source
1. Install the necessary dependencies
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.

[Rust](https://rustup.rs)

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

[mdBook](https://rust-lang.github.io/mdBook/) - Documentation framework
`cargo install mdbook`
1. Install dependencies

[mdBook-admonish](https://github.com/tommilligan/mdbook-admonish) - Admonitions plugin
`cargo install mdbook-admonish`
[Rust](https://rustup.rs)

[mdBook-i18n](https://github.com/tommilligan/mdbook-admonish) - Internationalization plugin
`cargo install mdbook-i18n`
`curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh`

[mdBook](https://rust-lang.github.io/mdBook/) - Documentation framework

1. Clone the repo and change into its directory
```
git clone [email protected]:kn0wmad/mdbook-docs
cd mdbook-docs
```
1. Serve and view a live, local version of the docs while editing
`mdbook serve --open`
`cargo install mdbook`

* This will automatically open your default web browser and navigate to http://localhost:3000
[mdBook-admonish](https://github.com/tommilligan/mdbook-admonish) - Admonitions plugin

`cargo install mdbook-admonish`

[mdBook-i18n](https://github.com/tommilligan/mdbook-admonish) - Internationalization plugin

`cargo install mdbook-i18n`

2. Clone the repo and change into its directory

```
git clone https://github.com/Start9Labs/docs.git
cd mdbook-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 not comfortable with this process, please create an issue with your suggestions or bug reports.

If you'd like to get started contributing to Open Source software, it's easier than you think! Visit one of our [Community Channels](https://docs.start9.com/latest/support/contact) and we'll help you get started.
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 not comfortable with this process, please create an issue with your suggestions or bug reports.

If you'd like to get started contributing to open source software, it's easier than you think! Visit one of our [Community Channels](src/support/contact.md) and we'll help you get started.

## Third party plugins

[External link to plugins](https://github.com/rust-lang/mdBook/wiki/Third-party-plugins)

## Possible `mdbook` admonitions

```admonish
A note.
```

```admonish example
An example.
```

```admonish info
Some info on this thing.
```

```admonish tip
Protip on this thing.
```

```admonish warning
You don't want to do this!
```

```admonish bug
Bonjour sucks, but it's gone now
```

```admonish danger
WTF ARE YOU DOING?!
```

```admonish warning title="Custom, i.e. -> POSSIBLE DATA LOSS"
The following steps can lead to irrecoverable data corruption.
```

```admonish success title=""
Admonition without title - This will take a while, go and grab a sandwich.
```

And tons more -> https://tommilligan.github.io/mdbook-admonish/reference.html
8 changes: 4 additions & 4 deletions book.toml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[book]
authors = ["[email protected]"]
authors = ["Start9"]
language = "en"
multilingual = false
src = "src"
title = "Start9 Documentation"
title = "Start9 Docs"

[output.html]
additional-css = ["./mdbook-admonish.css"]
additional-css = ["./mdbook-admonish.css", "./custom.css"]
git-repository-url = "https://github.com/start9labs/docs"
git-repository-icon = "fa-github"
edit-url-template = "https://github.com/start9labs/docs/edit/master/guide/{path}"
Expand All @@ -26,4 +26,4 @@ description = "Español"

[preprocessor.admonish]
command = "mdbook-admonish"
assets_version = "2.0.1" # do not edit: managed by `mdbook-admonish install`
assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
4 changes: 4 additions & 0 deletions custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.content img {
width: 100%;
max-width: 600px;
}
Loading

0 comments on commit 2514852

Please sign in to comment.