[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Convert README.org to plain text README while installing package

From: Po Lu
Subject: Re: Convert README.org to plain text README while installing package
Date: Sun, 05 Jun 2022 19:45:28 +0800
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.91 (gnu/linux)

Tassilo Horn <tsdh@gnu.org> writes:

> People nowadays write README.org and README.md files instead of
> plain-text READMEs because the packages' repositories are hosted on
> some forge (sr.ht, github, gitlab, gitea, whatever) which supports
> rendering those formats in a nice way.  So the choice of format is
> natural for package authors.  And they frequently contain markup like
> headings, bullet lists, bold, italics, and code snippets which simply
> look much better than their text-only alternative (even in their
> editing/non-rendered versions).

But that doesn't mean all documentation should take on such a format.
People read their READMEs in Emacs, not on a forge.

> That's true but wouldn't it be possible to extract the font-lock/faces
> related parts in a separate file with no dependencies which can be
> loaded quickly enough?  I mean, the purpose would only be to display org
> and markdown READMEs with the highlighting intended by the package
> author but there's no point in enabling the gazillon of other features
> (from editing to time-tracking to spreadsheet computations) those
> packages might provide in addition.

That wouldn't be Org mode anymore then, just an outline with some
additional fontification rules.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]