star-ty

Generate content for online publication
git clone git://git.meso-star.fr/star-ty.git
Log | Files | Refs | README | LICENSE

commit ea0e29b1c40b21c5a47da041b67b4b66879129ad
parent d610599c9010ae471ff09705bbecb45914ce6ec0
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 12 Nov 2025 15:50:22 +0100

Minor proofreading of the star-typesetting manual

Diffstat:
Mdoc/star-typesetting.7 | 14++++++--------
1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/doc/star-typesetting.7 b/doc/star-typesetting.7 @@ -39,17 +39,15 @@ Behind its apparent rigidity and simple appearance, .Nm offers great flexibility to authors who wish to go beyond simply publishing handwritten texts with default style. -The CSS has been written in a readable manner to encourage authors to -update it if necessary. -In addition, the Markdown syntax supports inline HTML for those who find -its syntax alone too restrictive. +The Markdown syntax supports inline HTML for those who find its syntax +alone too restrictive. It is also possible to write shell scripts that dynamically generate content when creating the website, for example to compose a page from external resources or to generate a list of downloadable archives from published files. Finally, .Nm -offers a system of hooks, i.e. shell scripts executed before content +offers a system of hooks, i.e., shell scripts executed before content generation, for example, to sign files offered for download or retrieve external content used to dynamically generate a web page. Hooks are ultimately a very versatile mechanism that can be used in many @@ -131,7 +129,7 @@ extension replaced by .Dq .md . These files are then processed by .Nm -as normal Markdown sources, i.e. converted to HTML files as described +as normal Markdown sources, i.e., converted to HTML files as described above. .Pp In principle, the root of a section should contain a Markdown file @@ -253,12 +251,12 @@ entry, except that the latter targets a directory that is not local to the working tree before it is deployed to the remote server. .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .Sh INDEX.TSV -Each section, i.e. each local subdirectory referenced in the +Each section, i.e., each local subdirectory referenced in the .Pa menu.tsv file, must contain an .Pa index.tsv file. -It defines the second-level entries in the navigation menu, i.e. the +It defines the second-level entries in the navigation menu, i.e., the content indexed in the section selected in the first-level menu. .Pp This file is formatted as a set of three values separated by tabs, which