Proposal: Use Markdown syntax for README and other documentation

X-seq: zsh-workers 50244

From: Bevan Stanely <bevanstanely@xxxxxxxxxx>

To: "zsh-workers@xxxxxxx" <zsh-workers@xxxxxxx>

Subject: Proposal: Use Markdown syntax for README and other documentation

Date: Wed, 18 May 2022 15:41:21 +0000

Accept-language: en-IN, en-US

Arc-authentication-results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=iisc.ac.in; dmarc=pass action=none header.from=iisc.ac.in; dkim=pass header.d=iisc.ac.in; arc=none

Arc-message-signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=g5iLJrD4oXNvJPNGePXkkJCKQ+9KxQvT0qOW4woiVwo=; b=TIpXs0OCPfqUWRkPVRi897ic7VETohk5BCq8RYl5KTXRiHMb6c6a8Ox4u4NzVCNH+U2vmOjRpahw/fCtonho/Axgo5cvs90RDVJABlww1QYZ6GRKaSZ5MsLcXuvOD8KsInI+gGOOFzJqGgt6VzcTsMnf+dwoaIoRwLoa8/WwUDrUGmpD2VbOYF0wgWutm3vkuuwOoQSH/lma7QfFuPMoNMV6bA+Oo/qV/TqbNIKA1RwVQzU5FlsiXNhApzj4UsO3gRyLqkzEUBZ61NYA5d8kPZ8rmNLSZeuQVveLJrQnQwg+MDwqySovdHHCw2HB9MUefmVqWmJ/jusjUmcjea6yZw==

Arc-seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=EfWnYOtFu4XezMx8b92ViFLLZoZ/bRYgmUXLLZc2FcCxjYzMx+COV2yj6HEa8NjxASLsOInKPIbuK9p6EvjAnzO+6c59eTePZMstL2NMce1HF3ZrnzZ7hJ6XpCpK/EHztIJC4wSsOMwVEb8TjNGRQ9kAMK3I21bEn0Mlbo+M0oTf3xZv4ND8MxrsJmdFy5eVTzh6n7UsS/5xbTewoVuYndvgNPDaS/aMBjfKgRb2/RVY+6UjBaZ4EiNFi3W/+EKIHnAZNlsbB2+T7o/DxkCDUVF1om4lIRw4Zhmecav6HfJ/7/HYQ75T881B7bDRKbezJwG9Z6c3ZrQDhfBgTp+sGA==

Archived-at: <https://zsh.org/workers/50244>

List-id: <zsh-workers.zsh.org>

Msip_labels:

Thread-index: AQHYaswvrDc5gotHKk2fQmCGrdWamg==

Thread-topic: Proposal: Use Markdown syntax for README and other documentation

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
 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. You may have a look at the file, as rendered by Github here. 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

Reverse Date

Date

Thread

Author