WIP: Pandoc unsquashed #199
Draft
Conversation
This file contains hidden or 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
Pandoc will convert markdown to pdf. By some cleverness we can get the same markdown file to both create the daffodil-site HTML page via jekyl, and create PDF doc via pandoc. Requires a make command in the _pandoc directory. It then searches for markdown files with `pdf: true` and converts those to pdf in the site/pdf directory. DAFFODIL-3044
pandoc doesn't do the markdown definition lists very well. DAFFODIL-3044
dfdl-extensions.md serves as the pandoc demo page. DAFFODIL-3044
DAF 1277 is closed as duplicate DAFFODIL-2769
Please run the site locally and look at the dfdl-extensions page and the layers page, and click the link to show the PDF files (near top of page). This contains pandoc so a common markdown file with some conditionalizations in it can generate both web pages using jekyll as usual, but also pdf files from the same markdown. Currently this requires you to cd to the site/_pandoc/ directory and type 'make' to run the makefile. That will find all pages with 'pdf: true' in their header and use pandoc to create PDFs for them. The PDFs are placed in site/pdf, and are currently checked into the repo. A drawback is you have to use a common markdown subset that works in jekyll and pandoc. And you have to remember to 'make' the PDFs. This is intended for a subset of our documenatation to use. Not every page has to have a PDF. DAFFODIL-3044
This is still a WIP. Not done: adding missing tbd content in the dfdl-extensions.md page. Not done: single PDF vs. one PDF per page. Not done: automated run of the Makefile. Still by hand for now. DAFFODIL-3044
DAFFODIL-3044
Start on doc for dfdlx:repType, repValues, and repValueRanges. DAFFODIL-3044
DAFFODIL-3044
DAFFODIL-3044
Draft
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
See #198
This is just a prior unsquashed version of the pandoc branch.
Preserved here to enable figuring out what broke it (pandoc hangs).