feat: Add facility to convert documents with pandoc #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evrardjp
suggested changes
Mar 14, 2022
evrardjp
reviewed
Mar 14, 2022
Add a facility to, with relative ease, create OpenDocument Text and Word documents from the original Markdown. To use, run tox -e to-odt -- -o output.odt input1.md input2.md input3.md or tox -e to-docx -- -o output.docx input1.md input2.md input3.md To achieve this, a simple script concatenates the input files, processes them against mkdocs.yml using the Jinja2 CLI, and feeds the result to pandoc with appropriate command-line options. For branding, reference.docx and reference.odt files can be placed into the pandoc subdirectory. Also, add bashate testing for the script itself.
There are several issue with admonitions, or rather with the way they are being rendered in the context of Material for MKDocs: * Their font is smaller than the text body font, which is counterproductive for a piece of information that is meant to be emphasised. * They use their own colour scheme, which is hard to align with branding. * They use their own syntax which involves indentation, and thus hijacks what's otherwise meant for preformatted text. * That specific meaning is lost on pandoc, which will render the admonitions as preformatted text in the process of converting to other formats. Thus, remove the admonitions. Convert them to regular paragraphs when appropriate; turn them into blockquotes when they do require additional emphasis.
Yup, done. |
evrardjp
reviewed
Mar 15, 2022
Thanks, the code looks good now. |
Yes it is, as its commit message states:
|
|
Ha, I guess I misread it, cause I looked at the commit message. LGTM then. |
Ack, can you change your review to "Approved" please? |
evrardjp
approved these changes
Mar 15, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a facility to, with relative ease, create OpenDocument Text and Word documents from the original Markdown. To use, run
or
To achieve this, a simple script concatenates the input files, processes them against
mkdocs.ymlusing the Jinja2 CLI, and feeds the result topandocwith appropriate command-line options.For branding,
reference.docxandreference.odtfiles can be placed into thepandocsubdirectory.Also, add
bashatetesting for the script itself.