Re: An improved README experience for PostgreSQL

From: "David E(dot) Wheeler" <david(at)justatheory(dot)com>
To: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
Cc: Joe Conway <mail(at)joeconway(dot)com>, Daniel Gustafsson <daniel(at)yesql(dot)se>, Nathan Bossart <nathandbossart(at)gmail(dot)com>, 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 18:54:59
Message-ID: C1E66A64-8923-4634-8A95-EE00743CECA0@justatheory.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

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.

Best,

David

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2024-02-28 19:06:44 Re: Fix for edge case in date_bin() function
Previous Message Nathan Bossart 2024-02-28 18:51:58 Re: Improve the log message output of basic_archive when basic_archive.archive_directory parameter is not set