Re: New website design: help needed

Hello

Indeed, MkDocs or Hugo are the best two options.
Both are terminal browser friendly, but you'd better test your theme of choice.
In both, you can write page content in Markdown, which means that any developer can contribute or update content.
And both can be hosted on GitHub with a custom domain and maybe some pipelines.

If you go the https://www.mkdocs.org/ route, then I recommend the following theme:
https://squidfunk.github.io/mkdocs-material/ (best MkDocs theme IMO)
Configuring and building the website is simple, which translates into maintenance time savings.
If you choose MkDocs, you'll have to manually enable the code copy button in this theme as it has more features than the bare MkDocs:
https://squidfunk.github.io/mkdocs-material/reference/code-blocks/?h=copy#code-copy-button
For example, the mentioned theme also offers admonitions:
https://squidfunk.github.io/mkdocs-material/reference/admonitions/

With Hugo, you can provide content in some other formats including HTML, which might be of hypothetical use for reusing some existing HTML pages:
https://gohugo.io/content-management/formats/
Hugo also offers a number of docs themes: https://themes.gohugo.io/tags/docs/
Just avoid a theme that is not actively maintained.
If you're looking for a clean Hugo them with support for docs and the code copy button,
then you can try this one: https://github.com/imfing/hextra
just might want to set a wider page width because the default text column is quite narrow: https://imfing.github.io/hextra/docs/guide/configuration/#page-width

The bottom line is the learning curve: MkDocs is easier to use, whereas Hugo is more complex due to a lot more features and as a result will probably take more time.
In the end, I bet you'll get more or less the same results whether you settle on MkDocs or Hugo.

Cheers
Max


On Monday, February 17th, 2025 at 7:31 AM, Yury V. Zaytsev via mc-devel <mc-devel-+hD5IHI5XseWCegYutOAJTiNl0CLU6MPYPYVAmT7z5s@public.gmane.org> wrote:

> Hi everyone,
> 
> As I'm slowly working on hammering many of the necessary nails into the coffin of our old Trac, I thought I'd ask for some help in designing a new website.
> 
> My general idea is this: most of the Trac content will be migrated to hosted services in the future, including the wiki. However, it would be nice to still have a landing page / index on midnight-commander.org .
> 
> In terms of requirements, I can think of the following:
> 
> * Ideally clean and light design (think terminalcss.xyz), accessible and browsable with both text mode / legacy browsers and modern software.
> 
> * The content should be similar to the current main page. I think it would be best to split it into several pages, but I wouldn't be completely against the idea of scrollable sections. As an example of some recent sites that caught my eye as being nice in terms of layout, structure and content, I can mention the new PCRE2 homepage: https://pcre2project.github.io/pcre2/ .
> 
> * The implementation should be HTML5, using some static generator - maybe hugo or mkdocs?
> 
> * There should be room for an AdSense plug.
> 
> Let me know if you can contribute. Ideally, if you have any questions, we can discuss that on the list, and then eventually you post your work as a GitHub repository / GitHub pages and we can fork it into our organization when it's time to move.
> 
> Thanks in advance if anyone gets back to me...
> 
> All the best,
> Yury
> --
> mc-devel mailing list
> mc-devel-+hD5IHI5XseWCegYutOAJTiNl0CLU6MPYPYVAmT7z5s@public.gmane.org
> https://lists.midnight-commander.org/mailman/listinfo/mc-devel
-- 
mc-devel mailing list
mc-devel-+hD5IHI5XseWCegYutOAJTiNl0CLU6MPYPYVAmT7z5s@public.gmane.org
https://lists.midnight-commander.org/mailman/listinfo/mc-devel