Skip to content

Commit 8179de5

Browse files
committed
docs: Revert documents
v0.2.3 still requires `extern crate sailfish_macros;`
1 parent ac728a8 commit 8179de5

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Dependencies:
3131
```toml
3232
[dependencies]
3333
sailfish = "0.2.3"
34+
sailfish-macros = "0.2.3"
3435
```
3536

3637
Template file (templates/hello.stpl):
@@ -48,6 +49,9 @@ Template file (templates/hello.stpl):
4849
Code:
4950

5051
```rust
52+
#[macro_use]
53+
extern crate sailfish_macros; // enable derive macro
54+
5155
use sailfish::TemplateOnce;
5256

5357
#[derive(TemplateOnce)]

docs/en/docs/getting-started.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ templates/
2929
Import the sailfish crates:
3030

3131
```rust
32+
#[macro_use]
33+
extern crate sailfish_macros; // enable derive macros
34+
3235
use sailfish::TemplateOnce; // import `TemplateOnce` trait
3336
```
3437

docs/en/docs/installation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,12 @@ In order to use sailfish templates, you have add two dependencies in your `Cargo
55
```toml
66
[dependencies]
77
sailfish = "0.2.3"
8+
sailfish-macros = "0.2.3"
89
```
10+
11+
`sailfish` crate contains runtime for rendering contents, and `sailfish-macros` serves you derive macros to compile and import the template files.
12+
13+
These crates are separated so that Rust compiler can compile them independently. This separation makes your compilation faster!
14+
15+
!!! Warning
16+
Make sure that the `sailfish-macros` version is larger than `sailfish`, otherwise the compilation may fail.

0 commit comments

Comments
 (0)