Public mdbooks

That is, mdbooks where the source code is available.

Collect information about the books

e.g. which configuration options do they use with which values, which plugins they use etc.

Data collected from:

• Awesome mdbook
• mdbooks
• mdbook-i18n-helpers
• The Rust Book translations

CONTRIBUTION

The site is itself an mdbook, but one where the md files are also generated.

The mdbooks.yaml file contains the list of mdBooks. If you'd like to add another one, just add it to the end of the list.

If you'd like to make improvements to the titles and/or the descriptions, you can do that too in the mdbooks.yaml file.

• The title can be in the native language of the book.
• The description should be in English and it should mention the native language.
• The repo is the https URL of the repository.
• The folder is an optional field indicating in which subfolder is the book.toml file. If it is in the root of the repo then no need for this field.
• The site is the https URL to the generated book, if available.
• TODO: We will need to add a branch field to support projects where the book is not in the default branch. For now just add it as a comment. See the one we already have in the mdbooks.yaml file.

In order to generate the md files for our book we clone all the repositories, collect the data from them and put them in the report folder where we already have our book.toml file.

RUN locally

Clone all the repositories to the repos folder. (You can also create a symbolic link called repos to point to some other disk.)

cargo run -- --clone

cargo run -- --report && mdbook build report

Because we generate all the md files in our own book they are listed in the .gitignore and that breaks the watch of mdbooks. So is won't rebuild automatically when we re-generate the report. That's why we need to run mdbook build every time we generate the report.

In another terminal run:

mdbook serve report

TODO

Add more books!

Some ideas for future development:

• Deal with non-default branches.
• Deal with all the plugins that are not public.
• Collect all the parameters and their values of all the plugins.
• Shall we run the most recent version of mdbook on these books to see if it works? We need to be careful running arbitrary code in the plugins!