Skip to content

Commit

Permalink
Update README.adoc asciidoctor#648
Browse files Browse the repository at this point in the history
  • Loading branch information
sturtison authored Jun 7, 2023
1 parent 67f2010 commit 56da459
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@ endif::[]
:uri-license: https://github.com/asciidoctor/asciidoctor-chrome-extension/blob/main/LICENSE
:uri-contributing: https://github.com/asciidoctor/asciidoctor-chrome-extension/blob/main/CONTRIBUTING.adoc
:uri-changelog: https://github.com/asciidoctor/asciidoctor-chrome-extension/blob/main/changelog.adoc
// AsciiDoc
// Asciidoctor Projects and Docs
:uri-asciidoctor-docs: https://docs.asciidoctor.org
:uri-asciidoc-docs: https://docs.asciidoctor.org/asciidoc/latest
:uri-asciidoctor-js-repo: https://github.com/asciidoctor/asciidoctor.js
// Webstores
:uri-chrome-webstore: https://chrome.google.com/webstore/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia
:uri-mozilla-addon: https://addons.mozilla.org/firefox/addon/asciidoctorjs-live-preview
Expand All @@ -40,8 +42,8 @@ endif::[]

Enjoy AsciiDoc everywhere your browser goes with the Asciidoctor Browser Extension

The {project-name} uses https://github.com/asciidoctor/asciidoctor.js[Asciidoctor.js]
to preview https://docs.asciidoctor.org/asciidoc/latest[AsciiDoc] files (.ad, .adoc, .asc, .asciidoc, and optionally .txt) as HTML inside Chrome (or Chromium), Brave, Firefox, Opera and Microsoft Edge.
The {project-name} uses {uri-asciidoctor-js-repo}[Asciidoctor.js]
to preview {uri-asciidoc-docs}[AsciiDoc] files (.ad, .adoc, .asc, .asciidoc, and optionally .txt) as HTML inside Chrome (or Chromium), Brave, Firefox, Opera and Microsoft Edge.

<<usage>> - <<get-started>> - {uri-project-repo}/issues[Submit an issue] - <<options>>

Expand Down Expand Up @@ -86,7 +88,9 @@ The following will help you explore the capabilities of the Extension:
to change how AsciiDoc and txt files are previewed with custom attributes, different themes, security, the Kroki diagram generator and more
* Show the Extension icon via your browser settings
* View an AsciiDoc file then:
** See its AsciiDoc by toggling the Extension off and on (quickly by clicking it the Extension icon)
** See its AsciiDoc by toggling the Extension inactive (colored) and active (colored)
+
You can do this quickly by clicking it the Extension icon if you show it (see above).
** Change the theme (perhaps to dark) in <<options>>
** Print it to PDF using the browser
* Add `toc=left` to Custom attributes in <<options>>
Expand All @@ -108,6 +112,7 @@ To get started, you will do three things in total:
1. Install the extension from the {uri-chrome-webstore}[Chrome Web Store] or the {uri-opera-addon}[Opera Add-ons website]
2. Configure the browser's options for the extension:
.. Type the URL `chrome://extensions` into the address bar and press kbd:[Enter]
.. Type `asciidoctor` into the extension search bar then when the {project-name} extension block is visible, click its btn:[Details] button.
.. Check `Allow access to file URLs`

You have installed the extension, and configured what the browser allows it to do.
Expand All @@ -120,7 +125,7 @@ Install the extension from the {uri-mozilla-addon}[Firefox Add-ons website]
You have now installed the extension.
Next, review and configure the <<options>>.

NOTE: There are known issues with FireFox. See <<known-issues>>.
NOTE: There are known issues with Firefox. See <<known-issues>>.

[#options]
== Extension options
Expand All @@ -129,13 +134,13 @@ NOTE: There are known issues with FireFox. See <<known-issues>>.

For {chromium-browser-list} you may open the options dialog in either of two ways: ::

* Via the Extension icon: When the {project-name} extension icon (red or gray) is visible on the extension toolbar, right-click the icon and choose menu:[Options].
* Via the Extension icon: When the {project-name} extension icon (colored or gray) is visible on the extension toolbar, right-click the icon and choose menu:[Options].
* Via the `chrome://extensions` page:
. Type `chrome://extensions` into the address bar and press kbd:[Enter]
. Type `asciidoctor` into the search bar, when the {project-name} extension block is visible, click its btn:[Details] button.
. Type `asciidoctor` into the extension search bar then when the {project-name} extension block is visible, click its btn:[Details] button.
. Click the *Extension options* link.

For Firefox you may opent the options in either of two ways: ::
For Firefox you may open the options in either of two ways: ::
* Via the Extension icon:
. Select menu:Hamburger menu[Addons and themes]
. Choose the Asciidoctor.js Live Preview extentions
Expand Down Expand Up @@ -230,7 +235,7 @@ To see your changes, click the `Reload` link in `about:debugging`.
These are the currently known issues.
For detailed issue tracking, see the GitHub {uri-project-repo}/issues[issue list].

=== Known FireFox issues
=== Known Firefox issues
With Firefox, pages viewed directly from GitHub may not render properly: ::
This is result of an open Firefox bug carrying over the Content Security Policies (CSP).
The restrictive CSP sent by GitHub are applied to the content inserted by the plugin.
Expand Down

0 comments on commit 56da459

Please sign in to comment.