You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When using Markdown to author documentation, some documentation processors e.g. Jekyll, make use of a front matter section e.g.
---
layout: default
title: Airline
permalink: index.html
---
# Airline
Airline is an annotation-driven Java library for building Command Line Interfaces (CLIs), it supports simple commands all the way through to complex Git style CLIs with groups and user defined command aliases.
Airline aims to reduce the boiler plate code typically associated with CLIs in Java, many common behaviours can be achieved purely with annotations and zero user code. Let's take a look at an ultra simple example:
This front matter is basically a section of YAML content that is used to provide variables to the documentation processor when generating the final output so the formatting of this section is significant.
If I use rewrap on this file it will re-wrap this section into a single line e.g.
Which will then break the documentation processor if I don't manually correct it.
This makes it annoying to rewrap content that wasn't previously consistently wrapped because you either have to remember to manually correct wrapping on the front matter (which I keep forgetting) or select the content excluding the front matter (which makes doing a quick Ctrl+A, Alt+Q a non-starter)
The text was updated successfully, but these errors were encountered:
- New architecture (still WIP) with performance increase.
- Markdown: new parser that fixes many small bugs (inc #288), as well as
supporting:
- Front matter header (#277, #294)
- Link reference definitions (#63, #93)
- Footnotes (#188)
- ReStructuredText support (standalone & for Python, almost complete)
(#88).
- Julia: support `#= ... =#` block comments (#302)
- Visual Studio: Wrap to rulers generated from .editorconfig by the
Editor Guidelines extension (thereby indirectly supporting
.editorconfig) (#300).
When using Markdown to author documentation, some documentation processors e.g. Jekyll, make use of a front matter section e.g.
This is actual example from one of my open source projects - https://github.com/rvesse/airline/blob/master/docs/index.md
This front matter is basically a section of YAML content that is used to provide variables to the documentation processor when generating the final output so the formatting of this section is significant.
If I use rewrap on this file it will re-wrap this section into a single line e.g.
Which will then break the documentation processor if I don't manually correct it.
This makes it annoying to rewrap content that wasn't previously consistently wrapped because you either have to remember to manually correct wrapping on the front matter (which I keep forgetting) or select the content excluding the front matter (which makes doing a quick Ctrl+A, Alt+Q a non-starter)
The text was updated successfully, but these errors were encountered: