zsh-workers
 help / color / mirror / code / Atom feed
From: Oliver Kiddle <opk@zsh.org>
To: Austin Traver <austintraver@icloud.com>
Cc: zsh-workers@zsh.org
Subject: Re: I'd like to help maintain the Zsh Web Page
Date: Mon, 29 Mar 2021 03:20:19 +0200	[thread overview]
Message-ID: <84773-1616980819.919111@ybx2.QGzt.Gdnm> (raw)
In-Reply-To: <481B0356-2B76-415A-8C1E-2BB6828420FC@icloud.com>

Austin Traver wrote:
> I feel the exact same way. Markdown is a great fit.

> I'd need to start by replicating the documentation in the equivalent
> markdown.

The actual documentation is something of a different matter. That's not
written in HTML but in a macro language named yodl that converts to any
of man pages, HTML or texinfo (from which it can be rendered to PDF,
info pages and other formats). The man pages are possibly the most
important form for the documentation. I'm not sure whether that can be
replicated from markdown but it really would need to be. texi2html is
quite configurable if we just want to tweak the web version of the
documentation. I'm not saying it has to be this way forever but take the
time to understand it first so you don't end up doing a lot of work that
goes to waste.

> What repositories host the Zsh documentation, is there a clone on GitHub I can fork?

The documentation is in a Doc directory alongside the source code -
https://git.code.sf.net/p/zsh/code
There are mirrors on github and gitlab if you prefer.
Sourceforge website content is https://git.code.sf.net/p/zsh/web
zsh.org website content is only the one file, so curl or saving from
firefox is probably easiest.

Oliver


  reply	other threads:[~2021-03-29  1:20 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-27 17:07 Austin Traver
2021-03-27 20:57 ` Daniel Shahaf
2021-03-27 20:59   ` Daniel Shahaf
2021-03-29  0:02 ` Oliver Kiddle
2021-03-29  0:39   ` Austin Traver
2021-03-29  1:20     ` Oliver Kiddle [this message]
2021-03-29  3:39       ` Austin Traver
2021-04-07  8:19         ` Austin Traver
2021-03-29  7:24   ` Daniel Shahaf

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=84773-1616980819.919111@ybx2.QGzt.Gdnm \
    --to=opk@zsh.org \
    --cc=austintraver@icloud.com \
    --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).