Re: An improved README experience for PostgreSQL - Mailing list pgsql-hackers

From David E. Wheeler
Subject Re: An improved README experience for PostgreSQL
Date
Msg-id C1E66A64-8923-4634-8A95-EE00743CECA0@justatheory.com
Whole thread Raw
In response to Re: An improved README experience for PostgreSQL  (Alvaro Herrera <alvherre@alvh.no-ip.org>)
Responses Re: An improved README experience for PostgreSQL
Re: An improved README experience for PostgreSQL
List pgsql-hackers
On Feb 28, 2024, at 1:51 PM, Alvaro Herrera <alvherre@alvh.no-ip.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




pgsql-hackers by date:

Previous
From: Nathan Bossart
Date:
Subject: Re: Improve the log message output of basic_archive when basic_archive.archive_directory parameter is not set
Next
From: Tom Lane
Date:
Subject: Re: Fix for edge case in date_bin() function