Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds navigation pane (TOC) to documentation pages
- Register Asciidoctor TOC into Awestruct page - Register Asciidoctor::Document to page context - Create a dedicated layout for documentation - Display a navigation pane (TOC) on the left of the screen - Add a toggle button to control bar hide/show the navigation pane - Change color of CTA button and bottom border of main navigation - control toc in documents rather than globally - keep user manual as standalone document - tweak margin around control bar
- Loading branch information
1 parent
6447d2e
commit f620320
Showing
37 changed files
with
245 additions
and
162 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
--- | ||
layout: base | ||
--- | ||
header | ||
.row | ||
- if page.url == '/' | ||
.large-8.columns.hero | ||
h1=page.title | ||
p.description | ||
|A <em>fast</em> text processor & publishing toolchain for converting AsciiDoc to HTML5, DocBook & more. | ||
.actions | ||
a.button.secondary href='https://rubygems.org/gems/asciidoctor' style='color: #6d180b; max-width: 220px;' | ||
i.fa.fa-download.fa-2x.pull-left | ||
|Download gem from RubyGems | ||
a.button.secondary href='https://github.com/asciidoctor/asciidoctor' style='max-width: 220px;' | ||
i.fa.fa-github.fa-2x.pull-left | ||
|Checkout source from GitHub | ||
.large-4.columns.hello | ||
/ TODO make this an AsciiDoc snippet when it becomes available in Slim | ||
.listingblock | ||
.content | ||
pre.CodeRay.highlight | ||
code data-lang='asciidoc' | ||
|= Hello, AsciiDoc! | ||
Doc Writer <doc@example.com> | ||
|
||
An introduction to http://asciidoc.org[AsciiDoc]. | ||
|
||
== First Section | ||
|
||
* item 1 | ||
* item 2 | ||
|
||
[source,ruby] | ||
puts "Hello, World!" | ||
- else | ||
.large-12.columns | ||
h1=page.title | ||
- if page.leadin | ||
p.description=page.leadin | ||
.row | ||
.large-8.columns | ||
#content | ||
=content | ||
.large-4.columns.secondary id='sidebar' | ||
- if page.url == '/' | ||
.quoteblock | ||
blockquote | ||
.paragraph | ||
|Use AsciiDoc for document markup. Really. It's actually <strong>readable</strong> by humans, easier to parse and way more flexible than XML. | ||
.attribution | ||
|— Linus Torvalds | ||
h4 Asciidoctor Project | ||
p | ||
|The Asciidoctor project is an effort to bring a comprehensive and accessible publishing toolchain, centered around the AsciiDoc syntax, to a growing range of ecosystems, including Ruby, JavaScript and the JVM. | ||
br | ||
br | ||
|In addition to an AsciiDoc processor and a collection of stylesheets, the project provides plugins for Maven, Gradle and Guard and packages for operating systems such as Fedora, Debian and Ubuntu. It also pushes AsciiDoc to evolve by introducing new ideas and innovation and helps promote AsciiDoc through education and advocacy. | ||
h4 Contribute to asciidoctor.org | ||
p This website is open source! The source is hosted under the Asciidoctor organization on GitHub. | ||
p If you want to help by improving upon it, <a href="https://github.com/asciidoctor/asciidoctor.org">fork the project</a>, revise the content, then send a pull request. When the pull request is merged, the site will be updated automatically. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
layout: base | ||
--- | ||
header | ||
.row | ||
.large-12.columns | ||
h1=page.title | ||
- if page.leadin | ||
p.description=page.leadin | ||
.row | ||
.large-4.columns | ||
ul.button-group.toolbar style='margin-bottom: -0.3333em' | ||
li: a.tiny.secondary.button.toggle-navigation href='#' | ||
i.fa.fa-toggle-on | ||
i.fa.fa-toggle-off | ||
| Nav | ||
li: span.separator | ||
li: a.tiny.secondary.button href="https://github.com/asciidoctor/asciidoctor.org/edit/master#{page.relative_source_path}" Edit | ||
li: a.tiny.secondary.button href="https://github.com/asciidoctor/asciidoctor.org/raw/master#{page.relative_source_path}" Raw | ||
li: a.tiny.secondary.button href="https://github.com/asciidoctor/asciidoctor.org/commits/master#{page.relative_source_path}" History | ||
li: i.fa.fa-github.fa-fw | ||
- if page.url =~ /^\/docs\/asciidoc-syntax-quick-reference/ | ||
li: a href='/docs/asciidoc-syntax-quick-reference.pdf' style='text-decoration: none' title='Download PDF': i.fa.fa-file-text-alt.fa-fw | ||
- if page.url =~ /^\/docs\/asciidoc-writers-guide/ | ||
li: a href='/docs/asciidoc-writers-guide.pdf' style='text-decoration: none' title='Download PDF': i.fa.fa-file-text-alt.fa-fw | ||
.row | ||
.large-4.columns.secondary.navigation | ||
div id='toc' class='toc' | ||
.title id='toctitle' =document.attr 'toc-title' | ||
=document.converter.convert document, 'outline', toclevels: 3 | ||
.large-8.columns.content | ||
#content | ||
=content |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
--- | ||
layout: base | ||
--- | ||
#content | ||
=partial('entry.html.slim', :post => page) | ||
.row | ||
.large-12.columns | ||
#content | ||
=partial('entry.html.slim', :post => page) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.