Using a Modern Doc Site Framework

[louiss0]

I'm here to ask you to use one of these sites to create your documentation.
Why? Because one of these technologies will make your site look good by default, and it will allow users to search for specific details. I'm not a docs expert, but I'm familiar with a few of the technologies listed here. If I have the time I can even write the docs for you using one these solutions.

I decided to do this because I think we can both benefit from this. I used your site to learn bash. It's old and outdated, so it needs to be fixed. All of these technologies allow you to do the a fewe of following things.

• Write Markdown for documentation
• Customize theming
• Use search for finding important things
• Use Callouts for specific things like tips, info, and warnings.
• Code Highlighting
• Asset Handling
• Internalization

All of these solutions give users the preceding features out of the box. The tools I recommend are.

Vitepress
Astro Starlight
Docsify
Docusarus

All of these tools are good enough for your needs. Out of all of them Docsify is the oldest one but doesn't provide search. I'm familiar with Vitepress I used it to create this site. For Astro Docs
It provides all the things that I mentioned here. If you're not familiar with vue or Astro then look at the astro docs.

[!warning] Warning
Some these technologies use a modern UI Framework like Vue React.
If you don't want to learn one I recommend Astro Starlight. If you know HTML,CSS and Javascript you know Astro

Astro Starlight

It's a new docs site for creating docs. It comes with many useful features for writing code. It allows you to create plain Multi Page sites. It's built on top of Astro which is a tool that allows you to write HTML templates by using the component model. Learning Astro isn't necessary at all just follow the docs and you should be fine. It uses a technology called pagefind to search for things by indexing your pages. It comes with a rich set of features related to expressing code with syntax.

Vitepress

A tool that is built on top of Vue. All Markdown pages created will be used for creating a Single Page App. It's an app that replaces content on a page
by using Javascript instead of loading new HTML pages. SPA's are typically faster than your average MPA when it comes to updating pages. It's fast. When it comes to search it uses a technology called minisearch to find many different terms. It supports preloading data. It's good for theming.

Docsify

It's not one that I know too well but it's very good for people that are used to using templating languages instead of the component model. It has lots of plugins for customization. It's doesn't have search unlike the previous technologies.

Docusaurus

It's a technology that It's created on top of React. It's used to create SPA's. It uses Markdown but you can also use something called MDX. A Markdown like version of JSX that allows you to lwrite functions that return HTML to be rendered. It's very mature and has quite a few plugins.