-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Correctly handle appendicies in md2html #3810
Conversation
We have an Appendix A that was getting treated as a numbered section, with a second Appendix A generated for references. This now correctly detects sections with "Appendix" in the name, and assigns letters appropriately. The generated references section is now Appendix B (and will always be the last appendix).
@ralfhandl let me see if I can figure out enough JavaScript for that 😅 |
@ralfhandl it looks a bit weird to me without the "Appendix" because then the word "Appendix" doesn't appear anywhere. Ideally we would keep "Appendix A: " in the main text and leave it out of the TOC- that is what IETF RFCs do. But I don't know how to make that happen and don't have more time to spend on this. If you feel strongly about taking it out we can just go with bare letters, but out of the two not-great options I'd rather leave the redundancy in (it's not worse than what we current have) and hope someone can figure out a better solution later. |
I'm sorry, I'm confused about how to preview the changes. I don't see Appendix B at all but I know we do some extra rendering. Am I just missing the docs on this? |
Bold of you to assume we have docs! 🤪 I was lazy and did not publish a rendering, as you have to bounce between different branches to do it (at least until #3717 is fixed) but i should have. Here are three relevant samples (edit the URLs in the obvious ways to see other versions if you want):
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! 👍
We have an Appendix A that was getting treated as a numbered section, with a second Appendix A generated for references.
This now correctly detects sections with "Appendix" in the name, and assigns letters appropriately. The generated references section is now Appendix B (and will always be the last appendix).