Call to Action: MarkDown in the Reference Library
|
Register for this free webinar:
https://zoom.us/webinar/register/WN_rkeXAYB8TqCcKSOOUuNuDA One of the outcomes of our recent education mini-summit was a decision to work on converting our existing Word Docs in the OpenChain GitHub reference library to markdown. The market has moved on from our early days of legal teams and management teams sharing documents, and from markdown we can easily convert to any other format. Lend a hand and help us reach even more people with our huge corpus of reference material (we have about 1,000 documents, so we need help to decide what is first, and how to share workloads around the globe based on people’s own priorities). Regards Shane Shane Coughlan OpenChain General Manager +818040358083 Book a meeting: https://meetings.hubspot.com/scoughlan |
|
|
|
Hi all,
During this discussion on converting to markdown, it was suggested that the Specification was one of the higher-priority targets. Possibly I’m being dense, but where does the master doc for the spec PDF live? I’m not seeing it in the Specification repo.
A question that came up was “are there tools to do mass/scripted conversion of documents?” As it happens, I was in another meeting today talking about conversion to markdown, and one of my colleagues pointed me at https://pandoc.org – looks perfect for this job to me.
steve
From:
main@... <main@...> on behalf of Shane Coughlan <scoughlan@...> [External] |
|
|
|
Carlo "Kappa" Piana
Pandoc is indeed what you need. We use it extensively in our toolchain. For most of documents it makes the cut embarrassingly easily and can be scripted. Requires some tweaking at times (like for using ATX style headers). And also the other way round: making good-looking documents out of simple markdown. You might want to look into Howdyadoc for more clues as to what's possible (includes some custom-made modules written in LUA and python). We use it to make contracts with cross-referenced numbering and stuff, just saying. Sorry I should have replied earlier. ;-) K Da: "Steve Kilbane" <stephen.kilbane@...>
|
|
|
|
Hi Steve!
toggle quoted message
Show quoted text
So, the baseline doc for the spec is in the GitHub spec repo under translation templates: Why not adjacent to the spec version PDFs under the official versions sub-folder of that repo? We did not want to take any risk of people downloading an editable document thinking they were downloading the spec, and the chance of that being accidentally or purposefully altered down the line. This is the first time we mentioned the concept of potentially messing with the editable spec document format, so we don’t currently have guidance at the repo root. Regards Shane Shane Coughlan OpenChain General Manager +818040358083 Book a meeting: https://meetings.hubspot.com/scoughlan On Aug 25, 2022, at 0:51, Steve Kilbane <stephen.kilbane@...> wrote:
|
|
|
|
Carlo, great lead.
toggle quoted message
Show quoted text
I have a todo item to prepare the first draft of our “here is what we are doing, where we want to do it, and how to do it.” I will fold this thread into that. ETA tomorrow. 👍 Shane Coughlan OpenChain General Manager +818040358083 Book a meeting: https://meetings.hubspot.com/scoughlan On Aug 25, 2022, at 1:03, Carlo Piana <carlo@...> wrote:
|
|
|