Dear All A short while back I posted a query “Compiling from source. SASL AUTH setup Dovecot & Cyrus.” link here:
https://www.mail-archive.com/[email protected]/msg107423.html In that discussion the point came up about updating the content of the “Postfix SASL Howto” page: https://www.postfix.org/SASL_README.html Separate to, but prompted by, that discussion I got to thinking about possibilities for refreshing the website also with the view to making it easy for different persons (if desired/required) to update the content of the Postfix website. I have been involved in the past with creating documentation content (for the doc website) for another open source project. Anyway, during that process I was involved with people looking at possible tools for building/maintaining website documentation. One tool that was looked at (which I personally liked) was the ‘Material for MkDocs’ add-on/theme for MkDocs. The maintainer of that, Martin Donath, has recently used all the experience from ‘Material for MkDocs’ to make a new, free, open-source, documentation website building tool — Zensical (https://zensical.org/). I had a look at Zensical and it does look very nice and it does provide an easy way for (collaborative) editing of content. * All the web pages are easily written in Markdown (.MD) files — no need for HTML knowledge. * While content is being written you can have a local website running to view content, the local serve engine refreshes content as it is written. * The (finished) website can then be exported using a build command which makes HTML pages (and some JavaScript tools, for example full site search) that can be uploaded to a web server. * The content (for the website) can be hosted on Github and multiple persons can, via pull requests, update the document repository. So... to try it out I spent a morning making a Zensical project (Zensical is done in Python) for the Postfix documentation copy/pasting content into Markdown pages. I made top level pages to build up the menu (left side) and for the Documentation pages I did most of the ’SASL Authentication’ page to show how pages would look. Zensical supports a modern UI/UX experience. I did a couple of screencasts and zipped up the (test) build directory. You can download them from Dropbox via this link: https://www.dropbox.com/scl/fo/2t2bkmq8bt8pvhmtisohy/ANTfpc3PwDJi-sNmjrhkqQo?rlkey=4twdd3skzqh6ve2s7yg0xd04h&st=w2exdt1h&dl=0 * Postfix_docs.mp4 = looking around the Python project and live preview of the website * Postfix_docs_search.mp4 = added short extra showing the search function and light/dark themes * site.zip = the (test) website HTML pages. You can load the files (individually) into a web browser to see what they look like. If one drops it into a web server the search functionality should also work. So — I just put it out here to see if there is any interest, it just took a morning’s work to build what you see in the screencasts and site HTML files. — Patrick _______________________________________________ Postfix-users mailing list -- [email protected] To unsubscribe send an email to [email protected]
