dfrommi/.Writing AsciiDoc in GitHub.adoc

Last active June 5, 2022 21:13

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/dfrommi/54613e8e23b377574dd04258dfb4290f.js"></script>
Save dfrommi/54613e8e23b377574dd04258dfb4290f to your computer and use it in GitHub Desktop.

Download ZIP

Common Asciidoc-setting for Gist adocs

Raw

.Writing AsciiDoc in GitHub.adoc

Tips for Writing AsciiDoc in Gists

Syntax highlighting

Supported source languages: https://github.com/github/linguist/blob/master/lib/linguist/languages.yml

Document configuation

Preamble that also renders nicely locally.

ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:

:diagram: source,mermaid
endif::[]

ifndef::env-github[]
:diagram: mermaid
:icons: font
:mmdc: /usr/local/bin/mmdc
endif::[]

Start mermaid-diagrams with [{diagram}]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment