Hugo VS Docusaurus

I would suggest looking into static site generators. Some popular examples, which are used myself are: - Hugo: https://gohugo.io/ - Jekyll: https://jekyllrb.com

I made a one-page theme for Hugo site generator that looks like Jake's resume. You can create resume page, deploy it on GitHub Pages and just print it to pdf file from browser for your needs afterwards. Demo page: https://schebotar.github.io/hugos-resume/ Repository: https://github.com/schebotar/hugos-resume

The site has been built with the Hugo static site generator since day one. Back in 2017, when I was originally building the site, I was a big fan of Hugo for its flexibility and speed. Hugo, which is built in Go, is known for extremely fast build times (for example, my 1200+ pages generate in about 7 seconds). This wasn't important when I built it, but it has been beneficial as the site grew large. And, while a lot has changed in the web development framework world since 2017, Hugo still does what I need it to.

The large differences in approaches and product features led us to rebuild the documentation for Camunda 8. C7 docs are hosted at docs.camunda.org; the version 8 documentation lives at docs.camunda.io. The two different sites are built with different tooling (Hugo vs Docusaurus).

In terms of GitHub stars, SSGs like Next.js, Hugo, Gatsby, Docusaurus, Nuxt.js, and Jekyll top the list. Some popular SSGs even host conferences and workshops, providing resources and networking opportunities for those looking to explore more advanced topics in depth.

After running my blog with Hugo hosted on Netlify for nearly a decade, I decided to migrate to a custom solution. I think I resisted the urge to rewrite my personal site for long enough and I deserve to have some fun. I am not going to find an excuse. I wanted to do this in Elixir. I wanted to build all the details of a static website from scratch once. It feels empowering to understand everything. And everything I learned along the way is generally useful Elixir knowledge. There are no concepts specific to a single static side generator.

I have migrated from Jekyll to Hugo for my own website, but the whole Hugo project is just weird. It took me like a year to migrate my simple website because of all the different paper cuts that drained my will to work on it.

You are only able to only use partials in HTML pages and shortcodes in Markdown pages. Why? They use 2 different syntax, so the best you can do is awkwardly wrap a partial in a shortcode. What's the point? They serve basically the same purpose.

Want to set up RSS? Oh yeah, for some reason by default it will not show full content in your feed reader, instead only a small extract with the only way to fix it is by making your own template[1]. But wait, why are we using RSS instead of Atom? Who knows, but if you want to use Atom, you have to use your template and insert some stuff to your config.

Also don't look at the bug tracker, that thing is frustrates me to no end.

You of course have the everyone's favourite Stalebot that you might have noticed in my previous link, but if you look at older issues, you will see the maintainer self-botting as a Stalebot[2][3] for some reason.

You will also see the maintainer moving issues between milestones for years with no end in sight[4].

Changelogs can sometimes feel a bit, odd too:

> but also a big shoutout to @dependabot[bot], […] for their ongoing contributions.

And commit messages sometimes are just… a bit too long[5] (it is truncated by GitHub, you can append .patch to see the full message).

Their documentation is awful to read too[6]. Oh and the templating engine? Yeah, not documented at all. Also the quick start guide will tell you to git clone some random theme, but I don't want my website to look like someone's, I want to write my own styles and have my own structure, but they don't really tell you anywhere how you should go about it. Because of it, I would search GitHub to sometimes find answers on how to do some stuff, but you would quickly find that most people had no idea how to actually use it. For example you can find a lot of people making opening and ending partials to have a common page layout instead of actually using the built-in Hugo layouts.

So why have I bothered switching? i18n support, so far out of all SSG I tried, Hugo does it in the least painful way.

[1]: https://github.com/gohugoio/hugo/issues/4071

[2]: https://github.com/gohugoio/hugo/issues/385#issuecomment-283...

[3]: https://github.com/gohugoio/hugo/issues/1035#issuecomment-28...

[4]: https://github.com/gohugoio/hugo/issues/448

[5]: https://github.com/gohugoio/hugo/commit/6dbde8d731f221b027c0...

[6]: https://news.ycombinator.com/item?id=30527884

That issue should have been closed. This was resolved in Hugo 112. https://github.com/gohugoio/hugo/releases/tag/v0.112.0

The fact that Hugo still doesn't play nicely with Tailwind 3 (2 years after T3 was released) is a real pain point.

I gave up on this ever being fixed quite a while back, but still check on the issue [1] every now and then. Seems like the only activity these days is bep bumping the milestone every month.

[1]: https://github.com/gohugoio/hugo/issues/8343

Docusaurus, a documentation tool by Facebook, hosts a showcase of other websites that use Docusaurus on their Homepage. The list of websites of this showcase is a typescript files that is maintained by Docusaurus devs, and that you can add your website to through PR: https://github.com/facebook/docusaurus/blob/main/website/src/data/users.tsx

Fix "Edit this page" links at the bottom of each doc (Problem with the Docusaurus build I guess)

How about docusaurus and tinasaurus? The latter is based on TinaCMS.

[1] Docusaurus:

https://docusaurus.io/

[2] Tinasaurus:

https://github.com/tinacms/tinasaurus

The large differences in approaches and product features led us to rebuild the documentation for Camunda 8. C7 docs are hosted at docs.camunda.org; the version 8 documentation lives at docs.camunda.io. The two different sites are built with different tooling (Hugo vs Docusaurus).

Fist, I got into Docusaurus Repo and searched codes that I was looking for, my keyword was codeblocks and there were some files involved with codeblocks. I could find the test file as well.

For this week, I found a couple of nice features from Docusaurus and I thought Code blocks feature is pretty cool and I'd like to add the feature to my static website general. For example, if you write 3 backticks with code in .md file, you will see code blocks below:

I know that Docusaurus supports Markdown front matter, and that its license allows for the code to be used and copied. Thus, I decided to use GitHub Code Search in its repo to find out how it is parsing the Markdown front matter.

Code in Docusaurus This module validates and processes frontmatter objects by using Joi library for the data validation.

Since its way easier to inspect code in an IDE compared to Github, I forked the repository and cloned my copy on the system.

This week, I looked into Docusaurus, one of the best and most popular tools to generate a beutiful documentation site in no time. It is known for its simplicity and ease of use. It provides a clean and modern design, search functionality, and a focus on creating an easy to maintain documentation for developers. No wonder it has a thriving community.