#docusaurus — Public Fediverse posts
Live and recent posts from across the Fediverse tagged #docusaurus, aggregated by home.social.
-
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
-
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
-
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
-
Meta’s React-Based Static Site Generator Docusaurus Now Offers Ai-Powered Search
#AI #Docusaurus #DeveloperTools #OpenSource #Meta #NodeJS #WebDev #JavaScript #React #Algolia #StaticSiteGenerators #Coding #SoftwareDevelopment
-
Měl bych se víc hlídat, takhle zbytečně přicházím o kredity zdarma… Dřív se za nadávání dávaly mince do prasátka, dneska člověk dostane „You've hit the Free plan limit for GPT-5“ 😕
-
🌟 Behold the groundbreaking revelation that TigerBeetle's team has reinvented the wheel by ditching #Docusaurus for their docs! 🙄 Apparently, their obsession with "TigerStyle" and "methodology" provides an unparalleled reading experience – because nothing screams #innovation like rebuilding #documentation from scratch. 🐯📚
https://tigerbeetle.com/blog/2025-02-27-why-we-designed-tigerbeetles-docs-from-scratch/ #TigerBeetle #TigerStyle #HackerNews #ngated -
Ускоряем документацию в 10 раз
Исправить опечатку в документации занимало 5 минут компиляции. Страницы с картинками загружались медленно. Я считаю, чтобы посмотреть документацию не нужен JavaScript. Расскажу как переехал с docusaurus + react на starlight + astro и оптимизировал сайт под экологию.
-
Myslel jsem si, že z kombinace #Jinja2 a #Markdown je akorát nepořádek, zvlášť když přimíchám makra, a že ten moderní přístup, to #MDX, kdy se všechno píše jako nějaké ty frontendové komponenty a tak, že by to bylo lepší.
Teď mám pod rukama větší projekt, kde je všechno to nové: #Docusaurus, .md, .mdx, .jsx, .tsx… a teda nemám pocit, že by to byl nějaký menší bordel.
Zjevně to vždy začne „budou to jen Markdown soubory v adresáři, fakt jen pár dynamických věcí“, a skončí to jako PHP verze 3.
-
@phlox @andre #mkdocs is good. #docusaurus (version 2) worth a look at too. https://docusaurus.io/. If you want more control then maybe #Gatsby and the #remark components? #Sphinx also worth looking at (with a more Python slant).
-
Neu in meinem Wiki: Werkzeuge für statische Dokumentationsseiten
Manchmal, wenn man etwas angefangen hat, läßt es einem nicht mehr los. So ging es mir mit dem Beitrag »Software-Dokumentation mit Markdown«, den ich vorgestern hier im Blog Kritzelheft veröffentlicht hatte. In meinen Kommentaren bekam ich einen Hinweis auf zwei weitere, interessante Werkzeuge und über meinen Feedreader schneite ein drittes herein. http://blog.schockwellenreiter.de/2022/06/2022061801.html #StatischeSeiten #Markdown #Markdoc #Docusaurus #Quarto
-
Neu in meinem Wiki: Werkzeuge für statische Dokumentationsseiten
Manchmal, wenn man etwas angefangen hat, läßt es einem nicht mehr los. So ging es mir mit dem Beitrag »Software-Dokumentation mit Markdown«, den ich vorgestern hier im Blog Kritzelheft veröffentlicht hatte. In meinen Kommentaren bekam ich einen Hinweis auf zwei weitere, interessante Werkzeuge und über meinen Feedreader schneite ein drittes herein. http://blog.schockwellenreiter.de/2022/06/2022061801.html #StatischeSeiten #Markdown #Markdoc #Docusaurus #Quarto
-
Neu in meinem Wiki: Werkzeuge für statische Dokumentationsseiten
Manchmal, wenn man etwas angefangen hat, läßt es einem nicht mehr los. So ging es mir mit dem Beitrag »Software-Dokumentation mit Markdown«, den ich vorgestern hier im Blog Kritzelheft veröffentlicht hatte. In meinen Kommentaren bekam ich einen Hinweis auf zwei weitere, interessante Werkzeuge und über meinen Feedreader schneite ein drittes herein. http://blog.schockwellenreiter.de/2022/06/2022061801.html #StatischeSeiten #Markdown #Markdoc #Docusaurus #Quarto