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

Add a Test Book to verify style changes against #1662

Merged
merged 4 commits into from
Oct 24, 2021

Conversation

YJDoc2
Copy link
Contributor

@YJDoc2 YJDoc2 commented Oct 5, 2021

Currently, there is no standard way to checking, verifying and validating changes done to styles or alignments of elements. Most of the time, people notice bugs in some mdBook book, and they fix and verify the fix on that book, see #1617 . This adds a test_book in the repo itself, which contains dummy examples of various tags by themselves and mixed together ; as well as examples of language snippets to validate changes in highlight.js (see point 8 in https://github.com/rust-lang/mdBook/blob/master/CONTRIBUTING.md#updating-higlightjs)

This is a big PR, in terms of additions, but none of it is any code changes to source code. All of it is addition of a new book in a directory called test_book.

This was referenced Oct 5, 2021
@YJDoc2
Copy link
Contributor Author

YJDoc2 commented Oct 10, 2021

This can be used as follows :
Run cargo run -- --serve ./test_book in root directory while making changes to styles etc, so that it will build it with the changes, and one can validate the style changes does not break anything.

Copy link
Contributor

@ehuss ehuss left a comment

Choose a reason for hiding this comment

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

Thanks, this looks great and will be very useful!

@ehuss ehuss merged commit 9e47498 into rust-lang:master Oct 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants