From: Bevan Stanely <bevanstanely@iisc.ac.in> To: Peter Stephenson <p.w.stephenson@ntlworld.com>, "zsh-workers@zsh.org" <zsh-workers@zsh.org> Subject: Re: Proposal: Use Markdown syntax for README and other documentation Date: Thu, 19 May 2022 18:23:29 +0000 [thread overview] Message-ID: <MA1PR01MB2876B6A968DF211C51BD0044E9D09@MA1PR01MB2876.INDPRD01.PROD.OUTLOOK.COM> (raw) In-Reply-To: <MA1PR01MB287610E1ADAE9945D8E41585E9D09@MA1PR01MB2876.INDPRD01.PROD.OUTLOOK.COM> [-- Attachment #1: Type: text/plain, Size: 1906 bytes --] Also one followup question, is yodl generating the documentation website as well? The .org and sourceforge ones. Bevan Stanely bevs.xyz<https://bevs.xyz/> ________________________________ From: Bevan Stanely <bevanstanely@iisc.ac.in> Sent: Thursday, May 19, 2022 8:52:41 PM To: Peter Stephenson <p.w.stephenson@ntlworld.com>; zsh-workers@zsh.org <zsh-workers@zsh.org> Subject: Re: Proposal: Use Markdown syntax for README and other documentation Thanks for the clarification. > I would imagine markdown, if used at all, would be restricted to a few package files that are currently plain text. I agree. Bevan Stanely bevs.xyz<https://bevs.xyz/> ________________________________ From: Peter Stephenson <p.w.stephenson@ntlworld.com> Sent: Thursday, May 19, 2022 8:46:18 PM To: Bevan Stanely <bevanstanely@iisc.ac.in>; zsh-workers@zsh.org <zsh-workers@zsh.org> Subject: Re: Proposal: Use Markdown syntax for README and other documentation External Email > On 19 May 2022 at 16:10 Bevan Stanely <bevanstanely@iisc.ac.in> wrote: > 1. What do you mean by rendering carefully formatted package documentation? > Is it similar to literate programming or something like doxygen? Or > markdown will be separate from source files. That was simply a slightly cryptic reference to use of markdown I've seen in other settings. > 2. I thought yodl was the tool currently being used to generate the > documentation website. I'm not sure if it's also handling man page > generation. Are you considering a substitute for that approach? Yodl is used for all internal documentation, including manual pages; as it's working OK I don't think discussions to change that have ever got very far --- it's easy to plan for, massively harder to do. I would imagine markdown, if used at all, would be restricted to a few package files that are currently plain text. pws [-- Attachment #2: Type: text/html, Size: 4469 bytes --]
next prev parent reply other threads:[~2022-05-19 18:24 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 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 [this message] 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=MA1PR01MB2876B6A968DF211C51BD0044E9D09@MA1PR01MB2876.INDPRD01.PROD.OUTLOOK.COM \ --to=bevanstanely@iisc.ac.in \ --cc=p.w.stephenson@ntlworld.com \ --cc=zsh-workers@zsh.org \ --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).