Skip to content

Commit

Permalink
Cleanup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ahus1 committed Oct 27, 2024
1 parent 4dc56fb commit 4b5157e
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,6 @@
:uri-asciidoctor-diagrams-execs: {uri-asciidoctor-diagrams-gh}#specifying-diagram-generator-paths
:uri-kroki: https://kroki.io

Check warning on line 5 in doc/users-guide/modules/ROOT/pages/features/preview/diagrams.adoc

View workflow job for this annotation

GitHub Actions / Qodana Docs

Typo

Typo: In word 'kroki'

// make preview work on non-Antora sites, for example, GitHub
ifndef::env-site[]
:imagesdir: ../../images
endif::[]

The preview of the AsciiDoc plugin supports rendering the diagrams in the preview.
Two different types of diagram renderer are supported: <<asciidoctor-diagram>> and <<kroki>>.

Expand Down
5 changes: 0 additions & 5 deletions doc/users-guide/modules/ROOT/pages/installation.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
= Installing the plugin
:description: List of prerequisites and a step-by-step guide to install the plugin.

// make preview work on non-Antora sites, for example, GitHub
ifndef::env-site[]
:imagesdir: ../images
endif::[]

{description}

For users already familiar with JetBrains IntelliJ, there's a xref:quick-start.adoc[] documentation.
Expand Down
5 changes: 0 additions & 5 deletions doc/users-guide/modules/ROOT/pages/quick-start.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
= Quick Start
:description: A minimal installation guide for those already familiar with their JetBrains IntelliJ based IDE.

// make preview work on non-Antora sites, for example, GitHub
ifndef::env-site[]
:imagesdir: ../images
endif::[]

{description}
Change to the page xref:installation.adoc[] for a more detailed guide,
or xref:technical-writing/index.adoc[] for a step-by-step-guide installing IntelliJ for technical writing.
Expand Down
5 changes: 0 additions & 5 deletions doc/users-guide/modules/ROOT/pages/recommended-settings.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
= Configuring the plugin
:description: Take a minute for the essential configuration settings of the plugin.

// make preview work on non-Antora sites, for example, GitHub
ifndef::env-site[]
:imagesdir: ../images
endif::[]

{description}

[#configuring-editor]
Expand Down

0 comments on commit 4b5157e

Please sign in to comment.