Shards: Rewrite manpages in asciidoc

Created on 11 Jan 2019  路  3Comments  路  Source: crystal-lang/shards

It would be nice to rewrite the manpages in asciidoc and to build them using the asciidoctor gem. It's nicer to write in, and that would allow to have different output formats (man, html, md, ...). Git does that and I really like it.

enhancement help wanted

Most helpful comment

I've just manually transformed the man page to Markdown 馃槃 (crystal-lang/crystal-book#316).
Having a single source format would definitely help to keep these instances in sync.

All 3 comments

I've just manually transformed the man page to Markdown 馃槃 (crystal-lang/crystal-book#316).
Having a single source format would definitely help to keep these instances in sync.

Calling asciidoctor with empty SOURCE_DATE_EPOCH env variable gives this error:

SOURCE_DATE_EPOCH= asciidoctor -a shards_version=0.14.0 docs/shards.adoc -b manpage -o man/shards.1
asciidoctor: FAILED: /home/zawertun/tmp/shards/docs/shards.adoc: Failed to load AsciiDoc document - invalid value for Integer(): ""
Use --trace for backtrace

(I'm building shards from the tar.gz archive, not from the git repo)

That makefile call is completely broken. Sorry, this was a really crappy copy and paste 馃槩

Fix is in #479.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mamantoha picture mamantoha  路  7Comments

Blacksmoke16 picture Blacksmoke16  路  8Comments

anatol picture anatol  路  3Comments

straight-shoota picture straight-shoota  路  7Comments

pyrsmk picture pyrsmk  路  4Comments