Totally normal workflow:

I work on documenting #Jinja syntax used in #CondaForge recipes.

https://github.com/conda-forge/conda-forge.github.io/pull/2782

I decide that the snippets would use Jinja syntax highlighting. However, #Prism doesn't have one. But Internets suggest Twig would work instead.

https://github.com/PrismJS/prism/issues/759

So I try Twig. Except that Twig highlighter crashes in #Docusaurus. But there's a workaround.

https://github.com/facebook/docusaurus/issues/8065

So I copy the code over to the project, fix it and while at it, rename it to "jinja" and adjust a bit.

But then, highlighting Jinja expressions alone looks pretty bleak, so let's combine it with YAML… Hmm, that actually doesn't work that well, needs some more adjustments. And before you know it, I have a pretty new Jinja highlighter, and a recipe highlighter that combines Jinja expressions, YAML, v0 recipe selectors, v1 if:/skip: conditions, and also highlighting shell / cmd variables for a good measure.

https://github.com/conda-forge/conda-forge.github.io/pull/2790

I'm considering improving our development documentation. We used Notion, but it wasn't very effective. As a wiki or knowledge store, it was simply too expensive. We switched to Slack Canvas, which feels clunky.

However, I had an idea: why not use a docs directory in our source code folder to structure our knowledge base in markdown files?

Perhaps we could use Jekyll or Docusaurus to create an internal website through a CI/CD pipeline? Or, we could even use our Git repository as a markdown viewer, including its search functionality.

Has anyone tried something similar? Are there any significant drawbacks? I want our developers to have the most straightforward experience possible. Occasionally, Notion felt overly complex and cumbersome to use. Additionally, a mediawiki, bookstack, or Wiki.js doesn't seem like the ideal solution, too.

Using markdown files in a structured folder structure appears to be an straightforward approach with a low threshold for adding or updating documentation.

Do I miss something?

#wiki #knowledge #knowledgebase #jekyll #dev #development #documentation #docusaurus #github

Massive update to the #ampache website!

The site has been rewritten in #docusaurus and has incorporated markdown from the GitHub wiki. (Which has been locked from updates)

Check it out!

https://ampache.org/

Our Documentation got an overhaul and we're now using #Docusaurus: https://cloudnative-pg.io/docs/

Huge thanks to Anushka Saxena who worked on this through the Linux Foundation's LFX mentorship program. We'll follow up with an interview with Anushka on our blog shortly!
#PostgreSQL #Kubernetes #Docs

To my friends who use #Docusaurus: how do I edit for example the layout of a blog post?

I'm very confused as there doesn't seem to be any layout files or templates in the directory to edit.

Générer une doc moderne avec #Docusaurus

https://blog.stephane-robert.info/docs/documenter/docusaurus/

#documentation