diff options
Diffstat (limited to 'docs-rs')
| -rw-r--r-- | docs-rs/README.md | 6 | ||||
| -rw-r--r-- | docs-rs/arborium-header.html | 1 |
2 files changed, 4 insertions, 3 deletions
diff --git a/docs-rs/README.md b/docs-rs/README.md index 3be1087a..46a3f559 100644 --- a/docs-rs/README.md +++ b/docs-rs/README.md @@ -3,14 +3,14 @@ This directory includes some templates and styling to extend and modify [rustdoc]'s output for Azalea's documentation on [docs.rs]. -See [Bevy's documentation](https://github.com/bevyengine/bevy/tree/main/docs-rs) for more info. +See [Bevy's documentation](https://github.com/bevyengine/bevy/tree/main/docs-rs) for more info on `trait-tags`. ## Local Testing -Build the documentation with the extension enabled like this: +Building the documentation with the extensions enabled can be done like this: ```bash -RUSTDOCFLAGS="--html-after-content docs-rs/trait-tags.html --cfg docsrs_dep" RUSTFLAGS="--cfg docsrs_dep" cargo doc --no-deps --package <package_name> +RUSTDOCFLAGS="--html-after-content docs-rs/trait-tags.html --html-after-content docs-rs/arborium-header.html --cfg docsrs_dep" RUSTFLAGS="--cfg docsrs_dep" cargo doc --no-deps --package <package_name> ``` [rustdoc]: https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html diff --git a/docs-rs/arborium-header.html b/docs-rs/arborium-header.html new file mode 100644 index 00000000..f0772b20 --- /dev/null +++ b/docs-rs/arborium-header.html @@ -0,0 +1 @@ +<script src="https://cdn.jsdelivr.net/npm/@arborium/arborium/dist/arborium.iife.js"></script>
\ No newline at end of file |