Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP Reorganize docs page #518

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/asciidoctor-docker.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:page-layout: base

include::https://cdn.rawgit.com/asciidoctor/docker-asciidoctor/master/README.adoc[]
50 changes: 50 additions & 0 deletions docs/developer-guide.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
= Developer Guide
:page-layout: base

== Implementations

[cols="1,3a"]
|===
| image:http://placehold.it/150x100&text=Ruby[]
|
[unstyled]
* API
* Parser
* AST
* link:/rdoc/Asciidoctor.html[Rdoc]
* link:/man/asciidoctor/[+asciidoctor+ man page]
* Yard
* Doctest Suite
* html-pipeline (infrastructure for GitHub)
| image:http://placehold.it/150x100&text=Java[]
|
[unstyled]
* link:../asciidoctorj/[API]
* http://www.javadoc.io/doc/org.asciidoctor/asciidoctorj/1.5.4[Javadoc]
* https://github.com/asciidoctor/asciidoclet[Asciidoclet]

| image:http://placehold.it/150x100&text=JavaScript[]
|
[unstyled]
* API
* webjars
* Browser
* Node
* Opal
| image:http://placehold.it/150x100&text=Groovy[]
|
[unstyled]
* https://github.com/asciidoctor/asciidoctorj-groovy-dsl[DSL]
|===

== Plugins

* link:../asciidoctor-gradle-plugin/[Gradle]
* link:../asciidoctor-maven-plugin/[Maven]
* https://github.com/asciidoctor/asciidoctor-gulp-plugin[Gulp]
* https://github.com/asciidoctor/asciidoctor-grunt-plugin[Grunt]
* https://github.com/asciidoctor/asciidoctor-lein-plugin[Leiningen]
* https://github.com/asciidoctor/asciidoctor-ant[Ant]
* https://github.com/ktoso/asciidoctor-sbt-plugin[sbt]
* https://github.com/asciidoctor/asciidoctor-intellij-plugin[Intellij]
* Eclipse (in progress)
73 changes: 0 additions & 73 deletions docs/extensions.adoc

This file was deleted.

131 changes: 131 additions & 0 deletions docs/getting-started.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
= Get Started with Asciidoctor
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's too much content in this page. Maybe we should split this page "Getting started" and "Ecosystem" ?

:page-layout: base
:uri-asciidoctor-org: https://github.com/asciidoctor

Let's setup and use the Asciidoctor toolchain!

== Installation

[unstyled]
* image:linux-logo.svg[Linux, 50, 50, link="../install-toolchain/"] link:../install-toolchain/[Linux]
* image:macosx-logo.svg[Mac OSX, 50, 50, link="../install-asciidoctor-macosx/"] link:../install-asciidoctor-macosx/[Mac OSX]
// TODO Add a dedicated guide to install Asciidoctor on Windows
// * image:windows-logo.svg[Windows, 50, 50, link="../install-windows/"] link:../install-windows/[Windows]
* image:docker-logo.svg[Docker, 50, 50, link="../asciidoctor-docker/"] link:../asciidoctor-docker/[Docker container]

== Viewing Tools

* http://gist.asciidoctor.org/[Docgist]
* link:../editing-asciidoc-with-live-preview/#chrome[Chrome Extension]
* link:../editing-asciidoc-with-live-preview/#firefox[Firefox Addon]
* link:../editing-asciidoc-with-live-preview/#opera[Opera Extension]
* link:../editing-asciidoc-with-live-preview/#using-a-system-monitor[Guard with Live Reload]

== Editing Tools

* link:../editing-asciidoc-with-live-preview/#atom[Atom]
* link:../editing-asciidoc-with-live-preview/#brackets[Brackets]
* link:../editing-asciidoc-with-live-preview/#asciidocfx[AsciiDocFX]

== Web Publishing

* http://hubpress.io/[HubPress.io]
* https://www.gitbook.com/[GitBook.io] (supports AsciiDoc)
* {uri-asciidoctor-org}/asciidoctor-confluence[Confluence]
* {uri-asciidoctor-org}/jekyll-asciidoc[Jekyll]
* https://github.com/opendevise/editions[Editions]
* https://middlemanapp.com/[Middleman]
* http://awestruct.org/[Awestruct]

== Converters

NOTE: You should first read link:../render-documents/[How-to render a document] to understand how Asciidoctor produces output formats.

* link:../render-documents/#rendering-a-document-to-html[HTML]
* link:../render-documents/#rendering-a-document-to-docbook[DocBook]
* link:../user-manual/#man-pages[Manpages]
* link:../convert-asciidoc-to-pdf/[PDF]
* link:../convert-asciidoc-to-epub[EPUB]
* http://www.noteshare.io/section/asciidoctor-latex-manual-intro[Latex]
* link:../install-and-use-deckjs-backend/[Deck.js]
* link:../install-and-use-revealjs-backend/[Reveal.js]
* link:../produce-custom-themes-using-asciidoctor-stylesheet-factory/[Stylesheets]
* DZSlides
* XHTML
* fopub (archived)
* Custom styles per converter

== Diagrams and Equations

* link:../asciidoctor-diagram/[PlantUML]
* link:../asciidoctor-diagram/[Ditaa]
* link:../asciidoctor-diagram/[GraphViz DOT]
* Shaape
* BlockDiag, SeqDiag, ActDiag, NwDiag
* Salt

== Extensions

This section is a catalog of Asciidoctor extensions.
In this context, an extension is a library that enriches the AsciiDoc content either by introducing new syntax or weaving additional features into the output.
This differs from tool extensions, such as the Atom extension, which bring AsciiDoc support to the tool.

=== Official Extensions

[cols="1,0,5"]
|====
|Name |Runtime |Description

|http://asciidoctor.org/docs/asciidoctor-diagram[Asciidoctor Diagram]
|Asciidoctor
|A set of extensions for Asciidoctor that allow you to embed diagrams written using the PlantUML, Graphviz, ditaa, or Shaape syntax inside your AsciiDoc documents.

|https://github.com/asciidoctor/asciidoctor-latex[Asciidoctor LaTeX]
|Asciidoctor
|Makes it possible to convert AsciiDoc documents into LaTeX and HTML.
It also brings an extended mathematical syntax for the AsciiDoc markup language that closely parallels LaTeX.

|https://github.com/asciidoctor/asciidoctor-extensions-lab[Extension Lab]
|Asciidoctor
|An experimental playground for upcoming extensions.
Used to test the capabilities of the extension mechanism and new extension ideas.

|====

NOTE: The label “official” simply means that the extension is hosted inside the Asciidoctor organization on GitHub and is maintained as part of the Asciidoctor project.
In contrast, a third-party extension is one hosted outside of the Asciidoctor organization.
This classification does not indicate the quality of the extension.
Instead, the quality should be based on the extension's own merit.

=== Third-party Extensions

[cols="1,0,5"]
|====
|Name |Runtime |Description

|https://github.com/domgold/asciidoctor-gherkin-extension[Asciidoctor Gherkin]
|AsciidoctorJ
|Includes Gherkin feature files in AsciiDoc in the form of sections, paragraphs, lists and tables.

|http://fix.github.io/asciidoctor-screenshot[Asciidoctor Screenshot]
|AsciidoctorJ
|Automates the inclusion of dynamically-generated screenshots into your documentation.

|https://github.com/RobWin/markup-document-builder[Markup Document Builder]
|AsciidoctorJ
|This project is a document builder for markup documents, including AsciiDoc.

|https://github.com/allati/asciidoctor-extension-monotree[MonoTree]
|AsciidoctorJ
|Visualizes tree-like structures.
It takes names for a tree node and it's nesting level as an input and draws a tree as an output.

|https://github.com/domgold/asciidoctor-sdedit-extension[Asciidoctor sdedit]
|AsciidoctorJ
|Creates sequence diagrams using sdedit.

|https://github.com/rmpestano/cukedoctor[Cukedoctor]
|AsciidoctorJ
|Enables BDD living documentation by integrating Cucumber and Asciidoctor.

|====
51 changes: 0 additions & 51 deletions docs/hack-asciidoctor-maven-plugin.adoc

This file was deleted.

Loading