summaryrefslogtreecommitdiff
path: root/docs/modules/html-backend
diff options
context:
space:
mode:
authorSarah White <graphitefriction@gmail.com>2020-11-19 15:45:59 -0700
committerSarah White <graphitefriction@gmail.com>2020-12-08 14:32:53 -0700
commit64ec52d2dacb0ff9c5e54ff47bc35f56a67b18ea (patch)
tree65bbc0d8d0d20350db63961a3b2e9b6b4f148a75 /docs/modules/html-backend
parenta0861ee354c26ab4480835c5f03ff16e7016ce61 (diff)
create integration modules; update stylesheet pages
Diffstat (limited to 'docs/modules/html-backend')
-rw-r--r--docs/modules/html-backend/nav.adoc4
-rw-r--r--docs/modules/html-backend/pages/custom-stylesheets.adoc (renamed from docs/modules/html-backend/pages/apply-stylesheet.adoc)2
-rw-r--r--docs/modules/html-backend/pages/index.adoc2
-rw-r--r--docs/modules/html-backend/pages/manage-stylesheets.adoc11
-rw-r--r--docs/modules/html-backend/pages/source-highlighting-stylesheets.adoc (renamed from docs/modules/html-backend/pages/apply-code-stylesheets.adoc)4
5 files changed, 11 insertions, 12 deletions
diff --git a/docs/modules/html-backend/nav.adoc b/docs/modules/html-backend/nav.adoc
index aa1054cb..396b226a 100644
--- a/docs/modules/html-backend/nav.adoc
+++ b/docs/modules/html-backend/nav.adoc
@@ -1,7 +1,7 @@
* xref:index.adoc[]
** xref:manage-stylesheets.adoc[]
-** xref:apply-code-stylesheets.adoc[]
-** xref:apply-stylesheet.adoc[]
+** xref:source-highlighting-stylesheets.adoc[]
+** xref:custom-stylesheets.adoc[]
** xref:favicon.adoc[]
** xref:manage-images.adoc[]
** xref:favicon.adoc[]
diff --git a/docs/modules/html-backend/pages/apply-stylesheet.adoc b/docs/modules/html-backend/pages/custom-stylesheets.adoc
index e645e664..1cc20d2a 100644
--- a/docs/modules/html-backend/pages/apply-stylesheet.adoc
+++ b/docs/modules/html-backend/pages/custom-stylesheets.adoc
@@ -6,7 +6,7 @@ apply-theme.adoc, included in:
////
A custom stylesheet can be stored in the same directory as your document or in a separate directory.
-Like the default stylesheet, you can have the output document link to your custom stylesheet or embed it.
+Like the xref:manage-stylesheets.adoc[default stylesheet], you can have the output document link to or embed your custom stylesheet.
If the stylesheet is in the same directory as your document, you can apply it when converting your document to HTML from the CLI.
diff --git a/docs/modules/html-backend/pages/index.adoc b/docs/modules/html-backend/pages/index.adoc
index 5c562bdb..be3c9ec3 100644
--- a/docs/modules/html-backend/pages/index.adoc
+++ b/docs/modules/html-backend/pages/index.adoc
@@ -9,7 +9,7 @@ Asciidoctor's default output format is HTML.
== Generate HTML using the html5 converter
-In this section, we'll create a sample document, then process and convert it with Asciidoctor's `html5` converter.
+In this section, we'll create a sample document, then process and convert it with Asciidoctor's built-in HTML converter.
. Create an AsciiDoc file like the one below
. Save the file as [.path]_my-sample.adoc_
diff --git a/docs/modules/html-backend/pages/manage-stylesheets.adoc b/docs/modules/html-backend/pages/manage-stylesheets.adoc
index aa6042b3..781c736e 100644
--- a/docs/modules/html-backend/pages/manage-stylesheets.adoc
+++ b/docs/modules/html-backend/pages/manage-stylesheets.adoc
@@ -3,13 +3,12 @@
== What is the default stylesheet?
Asciidoctor comes bundled with a stylesheet, named [.path]_asciidoctor.css_.
-It uses this stylesheet for HTML document styling and JavaScript for generating document attributes such as a table of contents and footnotes.
-This stylesheet is applied by default unless you tell Asciidoctor to use another stylesheet.
-See xref:html-backend:apply-stylesheet.adoc[] to learn about the default and custom stylesheet options.
+The built-in HTML converter uses this stylesheet for HTML document styling and JavaScript for generating document attributes such as a table of contents and footnotes.
+Asciidoctor applies this stylesheet by default unless you tell Asciidoctor to use another stylesheet.
== Embed a stylesheet
-When you generate a document with the `html5` backend, the [.path]_asciidoctor.css_ stylesheet is embedded into the HTML output by default when the safe mode is less than `SECURE`.
+When you generate a document using the built-in HTML converter, the [.path]_asciidoctor.css_ stylesheet is embedded into the HTML output by default when the xref:ROOT:safe-modes.adoc[safe mode] is less than `SECURE`.
If your stylesheet is being linked to when you expect it to be embedded, lower the safe mode (`safe` is the recommend value).
== Link to a stylesheet
@@ -37,10 +36,10 @@ Additionally, you can inspect [.path]_my-sample.html_ in your browser and see `<
//image::mysample-link.png[]
====
-== Don't apply a stylesheet
+== Disable a stylesheet
If you don't want any styles applied to the HTML output of your document, unset the `stylesheet` attribute.
$ asciidoctor -a stylesheet! my-sample.adoc
-One of Asciidoctor's strengths is the ease in which you can swap the default stylesheet for your own xref:apply-stylesheet.adoc[custom stylesheet].
+One of Asciidoctor's strengths is the ease in which you can swap the default stylesheet for your own xref:custom-stylesheets.adoc[custom stylesheet].
diff --git a/docs/modules/html-backend/pages/apply-code-stylesheets.adoc b/docs/modules/html-backend/pages/source-highlighting-stylesheets.adoc
index 42be39cb..0b9ad08a 100644
--- a/docs/modules/html-backend/pages/apply-code-stylesheets.adoc
+++ b/docs/modules/html-backend/pages/source-highlighting-stylesheets.adoc
@@ -1,4 +1,4 @@
-= Apply CodeRay or Pygments Stylesheets
+= Embed a CodeRay or Pygments Stylesheet
// um anchor: hl-css
// html-code-styles.adoc, included in convert-documents and the user-manual.
@@ -7,7 +7,7 @@ Asciidoctor can embed the stylesheet for the CodeRay or Pygments syntax highligh
== Requirements
First, make sure the appropriate library is installed on your system.
-See xref:integrations:rouge.adoc[], xref:integrations:coderay.adoc[], or xref:integrations:pygments.adoc[] for installation instructions.
+See xref:source-highlighters:rouge.adoc[], xref:source-highlighters:coderay.adoc[], or xref:source-highlighters:pygments.adoc[] for installation instructions.
Next, set the xref:asciidoc:verbatim:source-highlighter.adoc[source-highlighter attribute] and assign it the value that corresponds to the library you installed.
[#coderay]