https://github.com/holyjak/dash-asciidoc-cheatsheet

HTML-focused cheat sheet for AsciiDoctor, to be used in Dash for macOS
https://github.com/holyjak/dash-asciidoc-cheatsheet

Last synced: 2 months ago
JSON representation

HTML-focused cheat sheet for AsciiDoctor, to be used in Dash for macOS

• Host: GitHub
• URL: https://github.com/holyjak/dash-asciidoc-cheatsheet
• Owner: holyjak
• Created: 2021-09-22T10:32:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-10-11T10:09:42.000Z (about 2 years ago)
• Last Synced: 2024-05-01T21:10:06.352Z (8 months ago)
• Language: CSS
• Size: 92.8 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
AsciiDoctor cheat sheet creation for Dash

=========================================

An opinionated AsciiDoctor cheat sheet for the web author and tooling to turn it [into a docset for Dash for macOS](https://github.com/Kapeli/cheatset#readme).

Based partially on https://powerman.name/doc/asciidoc .

## Transformation steps

Prerequisites: [Babashka](https://babashka.org), Docker.

    # 1. .adoc -> HTML:

    docker run --rm -it -v (pwd):/documents/ asciidoctor/docker-asciidoctor \

      asciidoctor web-cheatsheet.adoc

    # 2. HTML -> raw docset & and the docset generator AsciiDoctor.rb

    bb html2dash.bb

There are two ways to get the docset into Dash:

1. Locally, you can manually add the created docset directory `./AsciiDoctor.docset/` This is preferable as the formatting and index are richer. In Dash go to Preferences... - Docsets - click the `+` at the bottom let corner - Add Local Docset - browse to `AsciiDoctor.docset`

2. From the generated docset generator `AsciiDoctor.rb` (see below) - this is how the docset is created by Dash itself, when I update https://github.com/Kapeli/cheatsheets/blob/master/cheatsheets/AsciiDoctor.rb[Kapeli/cheatsheets/../AsciiDoctor.rb].

Simulating how Dash produces a cheatsheet docset using https://github.com/Kapeli/cheatset/[cheatset]:

    # 3. .rb -> docset

    docker run --rm  -it --volume $PWD:/tmp --name cheatset jonasbn/cheatset:latest generate AsciiDoctor.rb

## Creating a release

Tag the code (`git tag 2.0.16/v2`), push (`git push; git push --tags`). On versioning: the version is `/`

Create a release manually from the pushed tag (even though GH will create a release automatically from the tag, you need to also create it manually so that our workflow kicks in) - _Draft release_, type the new tag name, …​ .

A GH action kicks in that builds the docset .zip and other artifacts and attaches it to the release.

Finally **submit a PR to update Kapeli/cheatsheets/../AsciiDoctor.rb**.