https://github.com/aergonaut/misto
https://github.com/aergonaut/misto
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/aergonaut/misto
- Owner: aergonaut
- License: apache-2.0
- Created: 2019-07-28T01:52:13.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-30T00:53:14.000Z (almost 6 years ago)
- Last Synced: 2025-02-09T19:29:50.346Z (3 months ago)
- Language: Rust
- Size: 18.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Misto
**Misto** is a crate providing integration between [Laravel Mix][] and Rust web
frameworks. It is framework agnostic, and simply provides a set of tools that
can be used to integrate with any framework.
[laravel mix]: https://laravel-mix.com/
## Installation
To use Misto, you must have Laravel Mix installed in your project.
Add the following to your `Cargo.toml`:
```toml
[dependencies]
misto = "^0.1.0"
```
## Framework Integration
Misto supports the [Tera][] template language via the optional feature `tera`.
To enable Tera integration, add the `tera` feature to your `Cargo.toml`.
[tera]: https://tera.netlify.com/
```toml
[dependencies]
misto = { version = "^0.1.0", features = ["tera"] }
```
## Usage
First, construct a `Manifest` instance from your `mix-manifest.json` file. This
file is generated by Laravel Mix at build time and contains a mapping between
your asset file names and the paths of the compiled assets. This is important
when using cache busting so that your templates don't need to be updated when
the asset fingerprint changes.
```rust
let mix_manifest = misto::Manifest::from_file("public/mix-manifest.json");
```
Replace `public/mix-manifest.json` with the path to your manifest file.
If using the Tera or Handlebars integrations, Misto provides a helper function
that you can use to automatically configure the template instance with Misto's
helper functions.
The following example shows this using Tera:
```rust
let mut tera = compile_templates!("templates/**/*");
misto::tera::configure(tera, mix_manifest);
```
Finally, in your templates, refer to your assets using the `asset_path` helper:
```tera
```
## 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.