On 10/29/2024 20:39, Oliver Kiddle wrote:
On 23 Oct, Clinton Bunch wrote:It's using Jinja templates to generate the static pages and storing release, mirrors, and news as JSON files so they only have to be updated in one place. The plan is to write more code to manage these JSON files.Given that we include release information in the source distribution, that would still need to be updated in two places. For the source distribution, we need something rather more amenable to being viewed in a terminal with less or even cat - so plain text or perhaps markdown. Is your intention that we treat the JSON files as the primary and generate either plain text or markdown from the JSON?
For the Release Notes, my plan was to keep the format of record the releases.html and use the python tool html2text to render it as markdown for the source distribution.
The News tidbits (more announcements) are what I converted to JSON.The JSON release file, just holds information like the src and doc tarball names, sourceforge URLs, version number, file sizes, release date, etc. There is also going to be support for a pre-release if one is generated.
As I mentioned before but never got around to writing a patch for, I think we should restructure the release notes in the source distribution in a manner similar to that used by the git project: individual files named by version number in a RelNotes directory and the top-level NEWS file being a symlink to the file for the latest release (except where it is still an unnumbered work-in-progress release). The current split between NEWS and README is not ideal. The approach of using Jinja sounds fine to me. Apart from the JSON files you mention, are you using Jinja directly within HTML?
To generate information from the JSON files and to get a consistent header and footer, and include all the link tags for stylesheets, icons, and preload fonts.
I've attached the Jinja template for the main page.
If someone can point me toward it, I'll try it as the header font. Though usually when trying to pair fonts, the net wisdom seems to be your best bet is to pair a serif with sans-serif.The site looks great to me. With regard to the fonts, I wonder whether it would be more consistent if we matched the font used in the Zsh logo although that was somewhat custom.
Including font files does increase the size somewhat.
Yeah, that may be a problem for mobile users.
The wizard can be shrunk by about 10% with zopflipng.
We may also be able to scale it down some.
Title: Welcome to Z Shell {% set page_title="Welcome to Z Shell" %} {% set balance_image="Zsh_wizard2.webp" %} {% include "header.inc.j2" %}Finally, thanks for working on this. Oliver
Zsh is a shell designed for interactive use, although it is also a powerful scripting language. Many of the useful features of bash, ksh, and tcsh were incorporated into zsh; many original features were added.
The introductory document details some of the unique features of zsh. It assumes basic knowledge of the standard UNIX shells; the intent is to show a reader already familiar with one of the other major shells what makes zsh more useful or more powerful. This document is not at all comprehensive; read the manual entry for a description of the shell that is complete, concise and up-to-date, although somewhat overwhelming and devoid of examples. Alternatively, the user guide offers wordy explanations of many of the shell's features. If you want to read something that has been polished by a professional editor you can buy the book.
Additional Documentation, and additional formats, is available on our Documentation page.
zsh-users@xxxxxxx
(Subscribe)
More information and links to the Archives
can be found on our Mailing Lists
pageThe latest release {{release['stable']['version']}} is available from SourceForge at {{release['stable']['src_tarball']}} (gpg_signature). Check out the Release Notes for information about this release. You can also find our mirrors, as well as downloadable documentation, at our Downloads page.
{{item.news | safe }}
The development sources can be gotten from SourceForge's git repository.
git clone git://git.code.sf.net/p/zsh/code zsh
For more information about development and how to contribute, see our Development page.