-
Notifications
You must be signed in to change notification settings - Fork 3.4k
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Convert all code listings to use new <Listing>
preprocessor
#3919
Comments
I'd like to help with chapter 1. |
Thanks for the feedback for my pervious contribution! I plan to work on converting chapters 2 and 3 |
Very good! Thank you! 💙 |
I'll do chapters 6-10. Already working on it. |
I am working on converting chapter 11. |
I'm in the process of converting 12-15. It is mostly working but all captions which have angle brackets (eg |
Interesting – I would not have expected that! 🤔 Let me know what you come up with. |
The issue appears to be that |
I've been quite busy over here, I hope to get back to work soon and finish the chapters. |
How do I build the mdbook with the Listing pre-processor? If I recall correctly, |
Also, what about code that is preceded by a filename, yet doesn't have a listing number? Are these also turned into |
@SpectralPixel sorry, just saw these questions.
|
Hmmm, I already converted those special |
Weird, mdbook seems not to work on my machine when I install it the way that is recommended for this repo... I guess I'll just send the PR so you can check if it works fine, it's probably just me doing something wrong with mdbook... |
@SpectralPixel if you consistently have issues with mdbook not working, would you open an issue? That way we can track fixing that—it’s important to us to make sure folks can contribute easily! |
Well, I'm not sure if I have it set up properly... |
@SpectralPixel @bzierk I believe #3975 should address the issues each of you were separately hitting in terms of what the |
As of #3918, we have a preprocessor that allows us to author with a custom HTML tag,
Listing
, roughly as if it were a component in a templating language. This input:…will generate this output in the regular book (and strip all the tags in the NoStarch book):
As described in the PR adding support for this, the result is more accessible HTML, which will also give us a nice way to hook in for styling things better if we so choose.
If you’d like to help, please leave a comment below noting which chapter you’d like to pick up so folks don’t do duplicate work! If it already has a user handle by it, please don’t work on that chapter.
Note for contributors: when converting to a
<Listing>
, you can drop the leadingListing <number>:
from thecaption
arg, since it handles that automatically with thenumber
arg.<Listing>
#3924)<Listing>
#3926)<Listing>
#3926)The text was updated successfully, but these errors were encountered: