# mdbook-shortcodes

[![Crates.io](https://img.shields.io/crates/v/mdbook-shortcodes.svg)](https://crates.io/crates/mdbook-shortcodes)
[![Docs.rs](https://docs.rs/mdbook-shortcodes/badge.svg)](https://docs.rs/mdbook-shortcodes)
[![CI](https://github.com/tsoutsman/mdbook-shortcodes/workflows/CI/badge.svg)](https://github.com/tsoutsman/mdbook-shortcodes/actions)
[![Coverage Status](https://coveralls.io/repos/github/tsoutsman/mdbook-shortcodes/badge.svg?branch=main)](https://coveralls.io/github/tsoutsman/mdbook-shortcodes?branch=main)

## Installation

### Cargo

* Install the rust toolchain in order to have cargo installed by following
  [this](https://www.rust-lang.org/tools/install) guide.
* run `cargo install mdbook-shortcodes`

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

See [CONTRIBUTING.md](CONTRIBUTING.md).