Simon Josefsson <[email protected]> writes:
>>> and realized that gitlab/github had reasonable support for orgdown
>>> markup, so maybe adding support for *.org files too would be useful?
>>
>> I wrote previously in this thread that I think we should allow *.org and
>> *.rst. Those, along with *.md, cover 99% of the README, etc. files that
>> I see.
>
> I recall seeing (and advocating for) *.adoc for AsciiDoc, and
> GitHub+GitLab seems to support it too, although I can't find any simple
> answer for codeberg.
That is what I have seen for AsciiDoc, but admittedly I don't know which
projects use it besides Git. They changed from .txt to .adoc a year ago [1].
> I suppose one tricky part is the regexp to cover all formats, I'm not
> sure '(*|#) Noteworthy ...' work for all?
Actually, I realized now it is a bit more complex than that. Here is a
sample top level header/title in each language.
Markdown:
# Header
Org mode:
* Header
AsciiDoc:
= Header
reStructuredText:
======
Header
======
Note that the overlining is optional and the line length must be greater
than or equal to the heading text.
So, I would ignore reStructuredText until someone actually voices a
desire to use it. Otherwise it will make searching for headers more
work.
I liked the format the few times I have used it, but I am happy enough
using Emacs 'outline-mode'. So I have no plans to change anything.
> Another matter is the preference order if there are multiple files?
> This will be opinionated but probably mostly irrelevant since few people
> have multiple files with different content. *.org, *.md, *.adoc, *.rst,
> NEWS?
My opinion is we should use whatever one is a regular file, i.e., not a
symbolic link.
If someone runs into issues because they actually use multiple formats,
we should try to convince them to clean it up. :)
Collin
[1] https://github.com/git/git/commit/1f010d6bdf756129db13d1367c888aa4153f6d87
