From: Bevan Stanely <email@example.com> To: "Lawrence Velázquez" <firstname.lastname@example.org>, dana <email@example.com> Cc: "firstname.lastname@example.org" <email@example.com> Subject: Re: Proposal: Use Markdown syntax for README and other documentation Date: Thu, 19 May 2022 06:04:28 +0000 [thread overview] Message-ID: <MA1PR01MB2876DDD7729194C2BF9B7F8AE9D09@MA1PR01MB2876.INDPRD01.PROD.OUTLOOK.COM> (raw) In-Reply-To: <firstname.lastname@example.org> [-- Attachment #1: Type: text/plain, Size: 1761 bytes --] This is the git tree of my commit in Sourceforge before I removed the raw HTML according to vq's opinion. It renders it fine. The only issue was the file extension. I understand the reasons for dreading any markup, it's just a proposal anyway if it's too inconvenient we can always drop the idea. https://sourceforge.net/p/zsh-fork/code/ci/a205af4809fbe2335438e6b83c1b55bdabba5504/tree/ ________________________________ From: Lawrence Velázquez <email@example.com> Sent: 19 May 2022 09:56 To: dana <firstname.lastname@example.org> Cc: email@example.com <firstname.lastname@example.org>; Bevan Stanely <email@example.com> Subject: Re: Proposal: Use Markdown syntax for README and other documentation External Email On Thu, May 19, 2022, at 12:02 AM, dana wrote: > On Wed 18 May 2022, at 20:10, Lawrence Velázquez wrote: >> While nice for editing, raw markup (even Markdown) makes for a poor >> reading experience. > > I don't think that's necessarily the case, as demonstrated by the fact > that Bevan thought we were already using Markdown lol. And we very nearly > are I agree that Markdown is not bad if limited to the quieter markup (e.g., headings, strong, emphasis, lists, blockquotes, etc.). Those also tend to be decently portable between implementations. The problem is that it's always tempting to move on to the less-quiet markup :-/ > I don't think it'd be a big change to have the README standardise on some > sub-set of Markdown to make it look a little nicer on code-hosting sites, > as long as we continued to avoid the more advanced/noisy features like > images and hyper-links The PR in question introduces both of those things, as well as raw HTML (which SourceForge would sanitize away) and backslash escaping. -- vq [-- Attachment #2: Type: text/html, Size: 3102 bytes --]
next prev parent reply other threads:[~2022-05-19 6:05 UTC|newest] Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top 2022-05-18 15:41 Bevan Stanely 2022-05-19 1:10 ` Lawrence Velázquez 2022-05-19 4:02 ` dana 2022-05-19 4:26 ` Lawrence Velázquez 2022-05-19 6:04 ` Bevan Stanely [this message] 2022-05-19 8:55 ` Peter Stephenson 2022-05-19 15:10 ` Bevan Stanely 2022-05-19 15:16 ` Peter Stephenson 2022-05-19 15:22 ` Bevan Stanely 2022-05-19 18:23 ` Bevan Stanely 2022-05-19 18:42 ` Bart Schaefer 2022-05-20 5:43 ` Bevan Stanely 2022-05-19 4:29 ` Bart Schaefer
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=MA1PR01MB2876DDD7729194C2BF9B7F8AE9D09@MA1PR01MB2876.INDPRD01.PROD.OUTLOOK.COM \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --subject='Re: Proposal: Use Markdown syntax for README and other documentation' \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
Code repositories for project(s) associated with this inbox: https://git.vuxu.org/mirror/zsh/ This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).