kantord/LibreLingo

Use asciidoc for documentation

开放

#1,013 创建于 2021年1月25日

 (37 条评论) (0 个反应) (0 位负责人)Python (258 个派生)github user discovery
help wanted

仓库指标

星标
 (2,630 个星标)
PR 合并指标
 (30 天内没有已合并 PR)

描述

This is a feature request. I am suggesting of writing all docs in a standard format, I suggest ASCIIDOC. Why am I asking this?

  1. Because Markdown is not a (real) format. I mean that Markdown is a "family" of dialects of formats. Currently there is not a definition of what is Markdown standard, just a more or less common subset of definitions. When people write Markdown in Github they actually write in the "github flavor" of markdown. That is just "one" MD flavor of the many existing ...

  2. Because Markdown lacks a lot of structures. MD was used exactly for this reason: simplicity at the cost of lack of features. No tables, no file include, no multilang, no intex, no toc, no sub rendering (latex, graphwiz, etc.) support, etc.

Instead Asciidoc for example is almost as complete as docbook, think of it as a simpler to use docbook alternative (see https://en.wikipedia.org/wiki/AsciiDoc). Asciidoc is a standard that is in this very moment in course of public standardization under the wing of the Eclipse foundation (See: https://www.eclipse.org/org/workinggroups/asciidoc-charter.php and https://projects.eclipse.org/proposals/asciidoc-language)

If this proposal will be accepted I can even do all the conversion work for you. Moreover, since github "understands" the asciidoc format quite well (it uses the same ruby libraries on which is based asciidoctor, the most advanced asciidoc compiler to date), after conversion one just have to save the doc files with the .adoc extension instead of .md and github will render them perfectly.

Let me know your (devs) decision

Marco Ciampa ciampix (a m p e r s a n d) posteo.net

贡献者指南