-
Notifications
You must be signed in to change notification settings - Fork 492
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 mdbook-spec #1520
Add mdbook-spec #1520
Commits on Jul 2, 2024
-
Start using mdbook-spec for the reference.
This preprocessor adds support for several Markdown extensions that should assist with writing.
Configuration menu - View commit details
-
Copy full SHA for 73fbd40 - Browse repository at this point
Copy the full SHA 73fbd40View commit details -
Copy the spec authoring guide over verbatim.
The next commit will update to keep in sync with the reference.
Configuration menu - View commit details
-
Copy full SHA for 850cdf4 - Browse repository at this point
Copy the full SHA 850cdf4View commit details -
Configuration menu - View commit details
-
Copy full SHA for b5966e9 - Browse repository at this point
Copy the full SHA b5966e9View commit details -
Configuration menu - View commit details
-
Copy full SHA for 31555be - Browse repository at this point
Copy the full SHA 31555beView commit details
Commits on Jul 4, 2024
-
Sort link section alphabetically
This link section was already sorted but for a recent change (that understandably probably preferred to keep the diff contained). Let's restore the sort order of the links here.
Configuration menu - View commit details
-
Copy full SHA for a7a9a69 - Browse repository at this point
Copy the full SHA a7a9a69View commit details -
The CONTRIBUTING guide seems wrapped at 80 character lines. Let's rewrap a paragraph with a line that had overflowed.
Configuration menu - View commit details
-
Copy full SHA for 6c5c972 - Browse repository at this point
Copy the full SHA 6c5c972View commit details -
Follow the authoring guide in the authoring guide
Let's follow our own rules in the authoring guide by, e.g., using `---` rather than the Unicode em-dash character, not wrapping lines, specifying the language for code block sections, etc. To improve formatting, we broke out some descriptions that were in code block sections into the main text. We replaced references to "the spec" with "the reference" for consistency, as that's what most of this document uses. And we made some other small editorial improvements.
Configuration menu - View commit details
-
Copy full SHA for b82955c - Browse repository at this point
Copy the full SHA b82955cView commit details -
Copy remaining style guidance to authoring guide
These two items of style were the only bits present in the style guide and missing from the authoring guide. Let's copy them over, since they are true of the Reference, and this will let us delete the style guide entirely.
Configuration menu - View commit details
-
Copy full SHA for 1b57f6c - Browse repository at this point
Copy the full SHA 1b57f6cView commit details -
Replace style guide with a link to the authoring guide
The authoring guide now fully incorporates and supersedes the style guide, so let's simply link to that from the style guide.
Configuration menu - View commit details
-
Copy full SHA for d376cba - Browse repository at this point
Copy the full SHA d376cbaView commit details