https://github.com/dioxuslabs/include_mdbook
[moved!] Include mdbooks at compile time in your Rust project
https://github.com/dioxuslabs/include_mdbook
Last synced: about 1 year ago
JSON representation
[moved!] Include mdbooks at compile time in your Rust project
- Host: GitHub
- URL: https://github.com/dioxuslabs/include_mdbook
- Owner: DioxusLabs
- Archived: true
- Created: 2023-05-31T21:13:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-05T00:01:30.000Z (over 1 year ago)
- Last Synced: 2025-04-08T02:46:47.310Z (about 1 year ago)
- Language: Rust
- Homepage: https://github.com/DioxusLabs/docsite/tree/main/packages/include_mdbook
- Size: 289 KB
- Stars: 24
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# this crate has moved!
https://github.com/DioxusLabs/docsite/tree/main/packages/include_mdbook
# `use_mdbook` - hooks and components for loading mdbooks with Dioxus
This crate provides the `use_mdbook` hook and `include_mdbook` macro that allows access to the contents of MdBooks at compile time.
This crate will integrate with a future Dioxus Assets system that allows image bundling outside the final output binary.
The point of this project is to power the Dioxus MdBook component ecosystem which enables any Dioxus app to easily include and render an MdBook.
Planned features for this crate:
- MdBook components (search, navbars, renderers)
- Hotreloading for mdbooks
- Devtool integration for live mdbook editing
## Todo:
- incremental processing with invalidation
- search manifest generation
- integration with dioxus bundle
- extract all logic to a generic asset system
- write mdbook as static str and not require json bouncing
- investigate compile time performance impacts