Zsh Mailing List Archive
Messages sorted by: Reverse Date, Date, Thread, Author

Re: I'd like to help maintain the Zsh Web Page




The actual documentation is… not written in HTML but in a macro language named yodl

I've worked with groff in the past, so I'm at least acquainted with macro packages such as mdoc. Yodl, I'm still working on learning, but I see this as a chance to learn something new.

The man pages are possibly the most
important form for the documentation.

I agree entirely, don't know what I'd do without them!

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'll make a first attempt using texi2html and let you guys know how it goes.

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.

In the past, I've learned the hard way what happens when developers build software now and understand requirements later. Not a fun time for anyone. I'll be sure to do this work in the correct order. 

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


Sounds good! If I reach a checkpoint, I'll post it to https://github.com/austintraver/zsh
Which remote (and branch) would I make a pull request to, when done? 

Best,
Austin


Messages sorted by: Reverse Date, Date, Thread, Author