From: Bevan Stanely <bevanstanely@iisc.ac.in>
To: "zsh-workers@zsh.org" <zsh-workers@zsh.org>
Subject: Proposal: Use Markdown syntax for README and other documentation
Date: Wed, 18 May 2022 15:41:21 +0000 [thread overview]
Message-ID: <MA1PR01MB28762D3415101EC7AC989DBEE9D19@MA1PR01MB2876.INDPRD01.PROD.OUTLOOK.COM> (raw)
[-- Attachment #1: Type: text/plain, Size: 895 bytes --]
Hello,
I have proposal to use markdown syntax for the README and other documentation in the project repo. Presently the files adhere to the minimal styling from alternate syntax<https://www.markdownguide.org/basic-syntax/#alternate-syntax> which mainly comprises of two levels of headings. Also there is no .md file extensions, which prevents markdown recognition by offline editors and Github.
As an initial step, I have separated out the list of backward incompatibilities to the file COMPATIBILITY and formatted the shorter README with markdown in this PR<https://github.com/zsh-users/zsh/pull/92>. You may have a look at the file, as rendered by Github here<https://github.com/bevsxyz/zsh#readme>. I think the efforts will enable the documentation to be more accessible and easy to navigate.
Let me know your thoughts on the matter!
Bevan Stanely
bevs.xyz<https://bevs.xyz>
[-- Attachment #2: Type: text/html, Size: 3284 bytes --]
next reply other threads:[~2022-05-18 15:42 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-18 15:41 Bevan Stanely [this message]
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
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=MA1PR01MB28762D3415101EC7AC989DBEE9D19@MA1PR01MB2876.INDPRD01.PROD.OUTLOOK.COM \
--to=bevanstanely@iisc.ac.in \
--cc=zsh-workers@zsh.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public 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).