Skip to content

Include mdbooks at compile time in your Rust project

Notifications You must be signed in to change notification settings

AmbientRun/include_mdbook

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

References

About

Include mdbooks at compile time in your Rust project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 100.0%