Skip to content

Commit

Permalink
Update/minor (#12)
Browse files Browse the repository at this point in the history
* add correct i18n repo link
* copy&paste friendly commands
  • Loading branch information
k0gen authored Jul 4, 2024
1 parent c4e5c8d commit d45b8bb
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,39 @@ Welcome to the Start9 Docs! Here you will find the StartOS user manual, as well

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

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

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

`cargo install mdbook`
```
cargo install mdbook
```

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

`cargo install mdbook-admonish`
```
cargo install mdbook-admonish
```

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

`cargo install mdbook-i18n`
```
cargo install mdbook-i18n
```

2. Clone the repo and change into its directory

```
git clone https://github.com/Start9Labs/docs.git
cd docs
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`
```
mdbook serve --open
```

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

Expand Down

0 comments on commit d45b8bb

Please sign in to comment.