zsh-workers
 help / color / mirror / code / Atom feed
* Proposal: Use Markdown syntax for README and other documentation
@ 2022-05-18 15:41 Bevan Stanely
  2022-05-19  1:10 ` Lawrence Velázquez
  0 siblings, 1 reply; 13+ messages in thread
From: Bevan Stanely @ 2022-05-18 15:41 UTC (permalink / raw)
  To: zsh-workers

[-- 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 --]

^ permalink raw reply	[flat|nested] 13+ messages in thread

end of thread, other threads:[~2022-05-20  5:44 UTC | newest]

Thread overview: 13+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-05-18 15:41 Proposal: Use Markdown syntax for README and other documentation 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
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

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).