| From: | Nathan Bossart <nathandbossart(at)gmail(dot)com> |
|---|---|
| To: | "David E(dot) Wheeler" <david(at)justatheory(dot)com> |
| Cc: | Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>, Joe Conway <mail(at)joeconway(dot)com>, Daniel Gustafsson <daniel(at)yesql(dot)se>, Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, Andrew Atkinson <andyatkinson(at)gmail(dot)com>, PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>, Samay Sharma <samay(at)tembo(dot)io> |
| Subject: | Re: An improved README experience for PostgreSQL |
| Date: | 2024-02-28 19:08:03 |
| Message-ID: | 20240228190803.GA2635693@nathanxps13 |
| Views: | Raw Message | Whole Thread | Download mbox | Resend email |
| Thread: | |
| Lists: | pgsql-hackers |
On Wed, Feb 28, 2024 at 01:54:59PM -0500, David E. Wheeler wrote:
> On Feb 28, 2024, at 1:51 PM, Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org> wrote:
>> *IF* people don't go overboard, yes. I agree, but let's keep an eye so
>> that it doesn't become an unreadable mess. I've seen some really
>> horrible markdown files that I'm sure most of you would object to.
>
> Markdown++
>
> IME the keys to decent-looking Markdown are:
>
> 1. Wrapping lines to a legible width (76-80 chars)
> 2. Link references rather than inline links
>
> I try to follow these for my blog; posts end up looking like this:
>
> https://justatheory.com/2024/02/extension-metadata-typology.text
>
> (Append `.text` to any post to see the raw(ish) Markdown.
Here is what converting the current README to Markdown with no other
content changes might look like.
--
Nathan Bossart
Amazon Web Services: https://aws.amazon.com
| Attachment | Content-Type | Size |
|---|---|---|
| 0001-Convert-README-to-Markdown.patch | text/x-diff | 1.6 KB |
| From | Date | Subject | |
|---|---|---|---|
| Next Message | Jelte Fennema-Nio | 2024-02-28 19:18:02 | Re: When extended query protocol ends? |
| Previous Message | Daniel Gustafsson | 2024-02-28 19:07:30 | Re: An improved README experience for PostgreSQL |