Re: [atomic-devel] Doc format?

[Matt Micene <nzwulfin gmail com>]

One option would be to pick one and then use pandoc to convert as needed, it supports conversions between asciidoc, markdown, and reStructuredText.

http://pandoc.org/try/ is an online version, you can paste one of the existing PA.io docs into it and see how the conversion looks.  We'd want to add a local version to the workflow, not the online.

On Mon, Mar 7, 2016 at 11:49 AM, Matt Micene <nzwulfin gmail com> wrote:

We need to support asciidoc for serious (lengthy) documentation use cases.

There's a stagnant group of us who are also intending to write official Fedora Docs, which needs reStructuredText support.

On Mon, Mar 7, 2016 at 11:30 AM, Aaron Weitekamp <aweiteka redhat com> wrote:

We need to support asciidoc for serious (lengthy) documentation use cases.

On Fri, Mar 4, 2016 at 6:59 PM, Josh Berkus <jberkus redhat com> wrote:

On 03/04/2016 12:09 PM, Joe Brockmeier wrote:

On 03/04/2016 02:24 PM, Josh Berkus wrote:

Out of all the Atomic projects, what are people using for docs?  Is it
all ASCIIdoc, or do we have other formats?

Most is Markdown. I'd recommend sticking with that excepting any
compelling need. Middleman will take ASCIIdoc, but I wouldn't want to
venture into anything beyond that.

One of the reasons I'm asking is that if most things are markdown, we can consider using ReadTheDocs.  But if we've got a lot of ASCIIDocs, we can't.

--
--
Josh Berkus
Project Atomic
Red Hat OSAS