https://github.com/http-rs/tide-book
https://github.com/http-rs/tide-book
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/http-rs/tide-book
- Owner: http-rs
- License: apache-2.0
- Created: 2020-10-15T16:00:46.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-11-28T20:41:51.000Z (over 4 years ago)
- Last Synced: 2025-01-12T17:43:15.670Z (over 1 year ago)
- Size: 1.26 MB
- Stars: 9
- Watchers: 9
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Tide book
This repository contains the source for the [Tide Book], the book is written in the `markdown` format and is built using [mdbook].
Languages:
- [English][Tide Book]
- [简体中文](https://github.com/zzy/tide-zh-cn), [在线阅读](https://tide.budshome.com)
## Development
The documentation can be edited using any text editor. Most commonly used editors support syntax highlighting for the `markdown` format. To view your changes you can install the [mdbook] tool locally, assuming you already have a working `Rust` setup;
```console
> cargo install mdbook
```
With [mdbook] installed you can use it to build and serve the documentation on your local system;
```console
> mdbook serve
```
this will start a local server that will be available on [localhost](http://localhost:3000) and will automatically build and re-build the documentation when it changes.
## Contributing
Want to help out? Check out our [The "Contributing" document][contributing]
### Conduct
The Tide project adheres to the [Contributor Covenant Code of
Conduct](https://github.com/http-rs/tide/blob/main/.github/CODE_OF_CONDUCT.md).
This describes the minimum behavior expected from all contributors.
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
[Tide Book]: https://http-rs.github.io/tide-book/
[mdbook]: https://rust-lang.github.io/mdBook/
[contributing]: https://github.com/http-rs/tide/blob/main/.github/CONTRIBUTING.md