Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #1710

Merged
merged 1 commit into from
Dec 30, 2021
Merged

Update documentation #1710

merged 1 commit into from
Dec 30, 2021

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented Dec 20, 2021

This is a large update to the documentation with the following changes:

  • Move some of the duplicated information from the README, and consolidate the information in the guide.
  • Rewrite the guide introduction. This includes a highlight of mdBook features.
  • Add a User Guide introducing how to use mdBook.
  • Add mdbook completions page.
  • Consolidate the installation instructions in one place.
  • Rewrite the Continuous Integration chapter, and move actual recipes to the wiki.
  • Rewrite the preprocessor and backend documentation to avoid duplication and make them consistent. Each has the "configuration" page which describes how to configure them in book.toml, and a separate "for developers" page explaining how to create a plugin.
  • General updates to configuration chapters.
  • Update the markdown chapter with more information, and include extensions.
  • More documentation on how code blocks work.
  • Various other minor changes.

Closes #602
Closes #814
Closes #822
Closes #827
Closes #1159
Closes #1278
Closes #1008
Closes #1202
Closes #1367
Closes #1590

@ehuss ehuss mentioned this pull request Dec 20, 2021
Copy link
Contributor

@joshrotenberg joshrotenberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment