Cheat sheet in the extension

[AllanDaemon]

Suggestion: Add a command to show an cheat sheet, ie. a reference, opening it inside VS Code.

This is a simple feature request, and I could make a PR for it.

So people that are not advanced yet with AsciiDoc can use as a reference when needed right inside the editor, with any need to open a browser and search for it, making it quicky accessible tight when you are writing and losing less time consulting references.

The idea is to use an existing reference for it, like https://powerman.name/doc/asciidoc-compact . I can check with the author of this one about licensing, so it would be to create a command that opens a new tab and render the reference and adapting (style) for the reference to look good in the VS Code tab.

It's pretty simple, but can be pretty useful, in particular for beginners with the language.

[danyill]

Sure, we'd welcome a PR for that.

One option is just to use the CLI output when the help topic is syntax:

asciidoctor -h syntax

We could add it as a snippet in https://github.com/asciidoctor/asciidoctor-vscode/blob/master/snippets/snippets.json

WDYT?

On Wed, Apr 15, 2020 at 3:11 PM Allan Daemon notifications@github.com wrote:

Suggestion: Add a command to show an cheat sheet, ie. a reference, opening it inside VS Code.

This is a simple feature request, and I could make a PR for it.

So people that are not advanced yet with AsciiDoc can use as a reference when needed right inside the editor, with any need to open a browser and search for it, making it quicky accessible tight when you are writing and losing less time consulting references.

The idea is to use an existing reference for it, like https://powerman.name/doc/asciidoc-compact . I can check with the author of this one about licensing, so it would be to create a command that opens a new tab and render the reference and adapting (style) for the reference to look good in the VS Code tab.

It's pretty simple, but can be pretty useful, in particular for beginners with the language.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/asciidoctor/asciidoctor-vscode/issues/297, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFEXX2WHXTXKODCYZUUVTDRMUQVZANCNFSM4MIHINXA .

--

-- Private or confidential message? Public Key available here https://pgp.mit.edu/pks/lookup?search=dan.mulholland%40gmail.com&op=index :

[AllanDaemon]

Sure, we'd welcome a PR for that.

Greate. I'll do that.

One option is just to use the CLI output when the help topic is syntax: asciidoctor -h syntax

That's a good option, but the example page I gave seems a bit more complete.

We could add it as a snippet in ...

In practice, I would create a new document, use the snippet and probably try to render it, every time. So it could be a snippet, but a command seems to be more practical.

[danyill]

hi @AllanDaemon thanks for volunteering a cheat sheet - is this something you're likely to get to any time soon?