I suggest you ...

support asciidoc as a base type

markdown is good, but asciidoc is just as, if not more concise markup format. Supporting asciidoc would allow people to include apiary application definitions inline in their technical specs, as well presentations.

Here are some examples of asciidoc used in this way:

formal specification:
https://github.com/jboss/cdi/tree/master/spec
renders to http://jcp.org/aboutJava/communityprocess/pr/jsr346/index.html

presentation:
http://mojavelinux.github.com/decks/

12 votes
Vote
Sign in
Check!
(thinking…)
Reset
or sign in with
  • facebook
  • google
    Password icon
    I agree to the terms of service
    Signed in as (Sign out)
    You have left! (?) (thinking…)
    Adrian ColeAdrian Cole shared this idea  ·   ·  Admin →
    declined  ·  Lukas LinhartLukas Linhart responded  · 

    For our new format, we have decided to be deeply rooted in Markdown format (every valid Blueprint will be valid Markdown), which mostly rules out plugging in asciidoc/reST/etc.

    We want our blueprint to be lingua franca of the API description and using multiple formats would fragment our community.

    For those who care deeply about other formats, please provide preprocessor which will export rest documentation into blueprint.

    3 comments

    Sign in
    Check!
    (thinking…)
    Reset
    or sign in with
    • facebook
    • google
      Password icon
      I agree to the terms of service
      Signed in as (Sign out)
      Submitting...
      • Alex SotoAlex Soto commented  · 

        Yes I have in my queue of work writing a post about using Asciidoctor (AsciiDoc) + MongoDB to generate documents, so dynamic processing is a really important thing that Asciidoctor provides for writing documentation.

      • Dan AllenDan Allen commented  · 

        In technical terms, AsciiDoc variables are referred to as attributes, in case you are looking for them in the user guide.

        http://asciidoc.org

      • Dan AllenDan Allen commented  · 

        The other feature that's *really* nice about AsciiDoc that would apply here is that AsciiDoc has variables. That means you can keep your specs DRY.

      Feedback and Knowledge Base