jesus/mdbook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
2965 commits 2 branches 0 tags 9.1 MiB
Commit graph

2965 commits

This branch
This branch
All branches
Author SHA1 Message Date
Eric Huss
a397f64356 Add a section on how to run tests 2025-07-23 17:47:31 -07:00
Eric Huss
fad53f720f Update guide to accommodate crate split 
This updates the docs now that the crate has been split into multiple
crates.
 2025-07-23 17:47:31 -07:00
Eric Huss
dcfb527342 Update crate docs 
This updates the crate-level docs to add a little more detail for each
crate.

This also drops the `mdbook` library crate, as it is no longer needed.
 2025-07-23 17:47:31 -07:00
Eric Huss
e0a4fb1ea9 Add READMEs for all new crates 2025-07-23 17:47:31 -07:00
Eric Huss
6e6518a7ae Move the remaining dependencies to the workspace table 
This is intended to have all dependencies only defined in the workspace
table, and crates can then refer to it.
 2025-07-23 17:47:31 -07:00
Eric Huss
12fc0ff5c3 Clean up dependencies of mdbook 
These are no longer used, or are dev-dependencies only.
 2025-07-23 17:47:31 -07:00
Eric Huss
b8a7b6e846 Simplify MDBook::iter doc 
The original was a little awkward, and I'm not sure what the tuple
syntax was intending to convey.
 2025-07-23 17:47:31 -07:00
Eric Huss
9229e80499 Clean up some remaining uses of mdbook_core 
These should be using the appropriate high-level crate.
 2025-07-23 17:47:31 -07:00
Eric Huss
ae6c4522bb Publicly re-export mdbook-core modules from mdbook-driver 
The intent here is to make mdbook-core a private dependency that the
user shouldn't need.
 2025-07-23 17:47:31 -07:00
Eric Huss
fdebbfdce2 Remove pulldown-cmark from mdbook-core 
This dependency is no longer directly used.
 2025-07-23 17:47:31 -07:00
Eric Huss
40745600a3 Finish move of MDBook to mdbook-driver 2025-07-23 17:47:31 -07:00
Eric Huss
5a31947eb7 Move MDBook to mdbook-driver 
This is a pure git rename in order to make sure that git can follow
history. The next commit will integrate these into mdbook-driver.
 2025-07-23 17:47:31 -07:00
Eric Huss
d758753551 Finish moving builtin renderers to mdbook-driver 2025-07-23 17:47:28 -07:00
Eric Huss
9b27b14985 Move built-in renderers to mdbook-driver 
This is a pure git rename in order to make sure that git can follow
history. The next commit will integrate these into mdbook-driver.
 2025-07-23 17:40:57 -07:00
Eric Huss
f5fc54461a Finish moving built-in preprocessors to mdbook-driver 2025-07-23 17:40:57 -07:00
Eric Huss
6aac696ee1 Move built-in preprocessors to mdbook-driver 
This is a pure git rename in order to make sure that git can follow
history. The next commit will integrate these into mdbook-driver.
 2025-07-23 17:40:57 -07:00
Eric Huss
c8571f592c Add mdbook-driver 
This is intended to hold the high-level MDBook type.
 2025-07-23 17:40:57 -07:00
Eric Huss
7eccd1d556 Finish move of hbs_renderer to mdbook-html 
This updates everything for the move of hbs_renderer to mdbook-html.
 2025-07-23 17:40:57 -07:00
Eric Huss
06324d8b24 Move hbs_renderer to mdbook-html 
This is a pure git rename in order to make sure that git can follow
history. The next commit will integrate these into mdbook-html.
Additional commits will refactor/move/remove items.
 2025-07-23 17:40:57 -07:00
Eric Huss
753780f653 Finish move of theme to mdbook-html 
This updates everything for the move of theme to mdbook-html. There
will be followup commits that will be doing more cleanup here.
 2025-07-23 17:40:57 -07:00
Eric Huss
3087686559 Move theme to mdbook-html 
This is a pure git rename in order to make sure that git can follow
history. The next commit will integrate these into mdbook-html.
Additional commits will refactor/move/remove items.
 2025-07-23 17:40:52 -07:00
Eric Huss
6805740e20 Add mdbook-html 
This new crate will hold the HTML renderer and related front-end parts.
 2025-07-23 17:29:55 -07:00
Eric Huss
8f3b6b4776 Move markdown support to mdbook-markdown 
This moves all the code responsible for markdown processing to the
mdbook-markdown crate.
 2025-07-23 17:29:55 -07:00
Eric Huss
3278f84373 Move renderer types to mdbook-renderer 
This sets up mdbook-renderer with the intent of being the core
library that renderers use to implement the necessary interactions.
 2025-07-23 17:29:55 -07:00
Eric Huss
12285f505d Move preprocessor types to mdbook-preprocessor 
This sets up mdbook-preprocessor with the intent of being the core
library that preprocessors use to implement the necessary interactions.
 2025-07-23 17:29:55 -07:00
Eric Huss
e123879c8c Move Book to mdbook-core 
This moves the Book definition to mdbook-core, along with related types
it needs.
 2025-07-23 17:29:55 -07:00
Eric Huss
7bcdfe6f0f Finish move of summary to mdbook-summary 
This updates everything for the move of summary to mdbook-summary. There
will be followup commits that will be doing more cleanup here.
 2025-07-23 17:29:55 -07:00
Eric Huss
29f936b1eb Move summary to mdbook-summary 
This is a pure git rename in order to make sure that git can follow
history. The next commit will integrate these into mdbook-summary.
Additional commits will refactor/move/remove items.
 2025-07-23 17:29:55 -07:00
Eric Huss
bd3e555962 Add mdbook-summary 
This new crate will hold the Summary types and parsing support.
 2025-07-23 17:29:55 -07:00
Eric Huss
02b6628048 Finish move of config to mdbook-core 
This updates everything for the move of config to mdbook-core. There
will be followup commits that will be moving and refactoring the config.
This simply moves it over unchanged.
 2025-07-23 17:29:55 -07:00
Eric Huss
4ae5a53791 Move config to mdbook-core 
This is a pure git rename in order to make sure that git can follow
history. The next commit will integrate these into mdbook-core.
Additional commits will refactor/move/remove items.
 2025-07-23 17:29:55 -07:00
Eric Huss
fc76a47d6e Finish move of utils to mdbook-core 
This updates everything for the move of utils to mdbook-core. There will
be followup commits that will be moving and refactoring these utils.
This simply moves them over unchanged (except visibility).
 2025-07-23 17:29:55 -07:00
Eric Huss
a224bfd7d7 Move utils to mdbook-core 
This is a pure git rename in order to make sure that git can follow
history. The next commit will integrate these into mdbook-core.
Additional commits will refactor/move/remove items.
 2025-07-23 17:29:55 -07:00
Eric Huss
f51d89ba02 Move error types to mdbook-core 
This moves Result and Error to mdbook-core with the anticipation of
using them in user crates. For now, the internal APIs will be using
anyhow directly, but the intent is to transition more of these to
mdbook-core where it makes sense.
 2025-07-23 17:29:55 -07:00
Eric Huss
461884f109 Add mdbook-preprocessor and mdbook-renderer 
These are two new crates intended to support implementing preprocessors
and renderers. Currently these stubs just have MDBOOK_VERSION, but
future commits will migrate more code to these crates.
 2025-07-23 17:29:55 -07:00
Eric Huss
bc3399cc22 Update version to 0.5.0-alpha.1 
This bumps the main crate to 0.5.0-alpha.1 in preparation for the 0.5
release.
 2025-07-23 17:29:55 -07:00
Eric Huss
4a655ff2a3 Add mdbook-core 
This is intended as a shared, internal library that will be used by
other mdbook crates. The intention is that those crates will either
directly use, or reexport items from this crate.

Initially this includes MDBOOK_VERSION, which will get reexported from
the preprocessor and renderer crates.
 2025-07-23 17:29:55 -07:00
Eric Huss
877a3af671 Add rustfmt.toml 
This is intended to help with editor integration for using the correct
style edition.
 2025-07-23 17:29:55 -07:00
Eric Huss
1499e850ac Add .git-blame-ignore-revs 
This is to help make it easier to traverse blame history for things like
formatting commits.
 2025-07-23 17:29:53 -07:00
Eric Huss
c7b67e363b Rustfmt for 2024 2025-07-23 17:29:12 -07:00
Eric Huss
d5a505e0c6 Update to Rust 2024 2025-07-23 17:29:12 -07:00
Eric Huss
0de13cf5a9 Update CI to test the whole workspace 
This updates the CI jobs to ensure that all crates in the workspace are
tested. This will be needed when more crates are added.
 2025-07-23 17:29:12 -07:00
Eric Huss
d6d5d6e674 Move common package settings to shared workspace table 
This moves common settings that can be shared across crates to the
shared workspace table. This will make it easier to maintain these
settings when adding more crates.
 2025-07-23 17:29:12 -07:00
Eric Huss
5264074c1b Move common lint controls to Cargo.toml 
This moves lint overrides to Cargo.toml so that they can more easily be
shared across crates.
 2025-07-23 17:29:12 -07:00
Eric Huss
702c676107
Merge pull request #2758 from ehuss/remove-release-toml 
Remove release.toml
 2025-07-22 00:58:38 +00:00
Eric Huss
a387846b20 Remove release.toml 
This hasn't been used in many years.
 2025-07-21 17:53:03 -07:00
Eric Huss
0eabdb0169
Merge pull request #2757 from ehuss/clippy-needless-lifetimes 
Remove clippy needless-lifetimes workaround
 2025-07-21 16:41:17 +00:00
Eric Huss
92836f3988 Remove clippy needless-lifetimes workaround 
This is no longer needed now that 1.87 has reached the stable channel.
 2025-07-21 09:35:54 -07:00
Eric Huss
05c6a99446
Merge pull request #2729 from GuillaumeGomez/info-log-location 
Show where the book was generated
 2025-07-15 22:29:51 +00:00
Guillaume Gomez
68893f785f Show where the book was generated 2025-07-15 15:24:35 -07:00