Import code/text from other files into your mdbook - without the link rot.
mdbook-superimport
started as an issue in mdbook #879.
At this time the default #include
preprocessor in mdbook
only supports importing smaller sections of a file by specifying
line numbers - so if you're including pieces of files that are actively maintained/changed you end up forgetting to update
the line numbers of your imports as your files change.
mdbook-superimport
allows you to import pieces of files based on text in the file - so that are you modify the file you continue
to import the code that you expected to.
sh
cargo install mdbook-superimport
```toml
[preprocessor.superimport] ```
```md
{{#superimport ../path/to/file.foo@some-tag-name-here}} ```
```rust // Some file named "file.foo" fn main () { let not_imported = "This will NOT be imported!";
// @superimport start some-tag-name-here
// ... let imported = "This will be imported!" let also_imported = "Everyting between start/end gets imported." // ...
// @superimport end some-tag-name-here } ```
sh
./test.sh
Apache 2.0 / MIT