Gentoo Archives: gentoo-dev

From: Tom Wijsman <TomWij@g.o>
To: mgorny@g.o, gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] markdown docs like README.md
Date: Tue, 24 Sep 2013 21:55:42
Message-Id: 20130924235020.1393e80d@TOMWIJ-GENTOO
In Reply to: Re: [gentoo-dev] markdown docs like README.md by "Michał Górny"
1 On Tue, 24 Sep 2013 22:15:15 +0200
2 Michał Górny <mgorny@g.o> wrote:
3
4 > Dnia 2013-09-24, o godz. 19:49:33
5 > hasufell <hasufell@g.o> napisał(a):
6 >
7 > > I wonder if it would make any sense to take the effort to convert
8 > > markdown docs to html format before installing them.
9 >
10 > What for? The point of markups like Markdown is for the text to be
11 > readable as plain text. Converting it to HTML goes against
12 > this principle.
13
14 You are pulling things out of context. Let me quote [1]:
15
16 > Thus, “Markdown” is two things: (1) a plain text formatting syntax;
17 > and (2) a software tool, written in Perl, that converts the plain
18 > text formatting to HTML.
19
20 (1) If it is a formatting syntax, then why would we make text any
21 more readable than it already is; actually, by mangling it with
22 formatting constructs it could even end up being less readable.
23
24 (2) It is a tool as well, saying it goes against a principle would be
25 denying its existence and usefulness; consider that the global use of
26 Markdown consists of a lot of conversion, we shouldn't neglect that
27 people want to use it as it benefits them.
28
29 Principle or not, we shouldn't force our users down a particular way to
30 reading them; as that's not what our meta-distribution stands for.
31
32 [1]: http://daringfireball.net/projects/markdown/
33
34 --
35 With kind regards,
36
37 Tom Wijsman (TomWij)
38 Gentoo Developer
39
40 E-mail address : TomWij@g.o
41 GPG Public Key : 6D34E57D
42 GPG Fingerprint : C165 AF18 AB4C 400B C3D2 ABF0 95B2 1FCD 6D34 E57D

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies

Subject Author
Re: [gentoo-dev] markdown docs like README.md "Michał Górny" <mgorny@g.o>