cadnza / asciidoc-author

Better AsciiDoc highlighting for authoring in VSCode 🪶

AsciiDoc Author

A few tiny pushes to make AsciiDoc authoring in VSCode more fun, especially when you're writing one sentence per line. Think of it as syntax highlighting for your manuscript. 🎨

Before

After

Features

• Bold, italic, and attribute highlighting within quote strings
• Formatting for punctuation
• Multi-line quote support
• Formatting for {l} and {r} as quote attributes if you're using non-standard quotes
• {openqd}, {openqs}, and {endq} operators for multi-paragraph quotes
  • VSCode likes to match opening tags with closing tags for syntax highlighting, and AsciiDoc won't substitute open-quote characters that aren't matched with close quotes. Multi-paragraph quotes count on unmatched close quotes, though, so {openqd} renders an open double quote, {openqs} renders an open single quote, and {endq} closes either. Here's how to use them:

:endq:
:openqd: “
:openqs: ‘

"`So you think that money is the root of all evil?`" said Francisco d’Aconia.
{openqd}Have you ever asked what is the root of money?
Money is a tool of exchange, which can’t exist unless there are goods produced and men able to produce them.
Money is the material shape of the principle that men who wish to deal with one another must deal by trade and give value for value.
Money is not the tool of the moochers, who claim your product by tears, or of the looters, who take it from you by force.
Money is made possible only by the men who produce.
Is this what you consider evil?{endq}

"`When you accept money in payment for your effort, you do so only on the conviction that you will exchange it for the product of the effort of others.
It is not the moochers or the looters who give value to money.
Not an ocean of tears nor all the guns in the world can transform those pieces of paper in your wallet into the bread you will need to survive tomorrow.
Those pieces of paper, which should have been gold, are a token of honor--your claim upon the energy of the men who produce.
Your wallet is your statement of hope that somewhere in the world around you there are men who will not default on that moral principle which is the root of money.
Is this what you consider evil?`"

Note that this extension provides syntax tokens, not formatting. For that you'll need something like the following in your settings.json:

"editor.tokenColorCustomizations": {
	"textMateRules": [
		{
			"scope": "markup.substitution.attribute-reference.asciidoc",
			"settings": {
				"foreground": "#66ccff"
			}
		},
		{
			"scope": "markup.italic.quote.typographic-quotes",
			"settings": {
				"foreground": "#FF4D4D",
				"fontStyle": ""
			}
		},
		{
			"scope": "markup.italic.quote.typographic-quotes.multiline.attribute-assigned.asciidoc",
			"settings": {
				"foreground": "#AA80FF"
			}
		},
		{
			"scope": "text.asciidoc.author.punctuation",
			"settings": {
				"foreground": "#79d279"
			}
		}
	]
}

See also

For more info, check out the Syntax Highlighting Guide and the TextMate grammar reference.

Happy authoring!