search

gbif / doc-effective-nodes-guidance

Repo for prototype documentation used to establish an integrated workflow to produce, maintain and publish GBIF documentation
https://doi.org/10.15468/doc-z79c-sa53
Other
2 stars 2 forks source link

Experiment with asciidoc #12

Closed MattBlissett closed 5 years ago

MattBlissett commented 5 years ago

I've made a new branch https://github.com/gbif/effective-nodes-guidance/tree/asciidoc with an Asciidoc example:

  1. I automatically converted (pandoc -f Markdown -t asciidoc) everything to Asciidoc.
  2. Added an index page, required for producing a single-page PDF/HTML. (I think GitBook was inferring this from the numbered folders.)
  3. Made some small changes to anchors (the internal links) necessary for a single-page book, as introduction was used several times
  4. Rejigged the title slightly, and moved the first "box" into one of those things with a ❗.
  5. Added a build on the Jenkins server: https://builds.gbif.org/job/document-effective-nodes-guidance/
  6. Building to Labs: https://labs.gbif.org/~mblissett/effective-nodes-guidance/ and https://labs.gbif.org/~mblissett/effective-nodes-guidance/index.pdf

I haven't looked at all at styling, or any of the text beyond the end of "2. Introduction". Numbers need removing from titles, the tables need converting from HTML to Asciidoc, and it's just the default style for both HTML and PDF.

Commits to the asciidoc branch will automatically cause a new build and deploy, if you merge this to master someone will need to update the branch used by Jenkins.