Skip to content
This repository has been archived by the owner on May 28, 2022. It is now read-only.

Add Asciidoctor coding standard #76

Open
kychua opened this issue Mar 6, 2017 · 0 comments
Open

Add Asciidoctor coding standard #76

kychua opened this issue Mar 6, 2017 · 0 comments

Comments

@kychua
Copy link

kychua commented Mar 6, 2017

Guidelines for compatibility with GitHub preview:

  • use :imagesDir: in document header instead of build.gradle so GitHub knows where to find the images
  • handling links to other .adoc files: use <<UserGuide#,User Guide>> instead of <<UserGuide.adoc, User Guide>> or <<UserGuide.html, User Guide>>, with ifdef::env-github,env-browser[:outfilesuffix: .adoc] in document header
  • handling relative links where directory structure is different on GitHub pages & GitHub preview: use ifdef::env-github,env-browser[:relfileprefix: docs/] in document header
  • handling section links: set idprefix: ''
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant