#docusaurus — Public Fediverse posts
Live and recent posts from across the Fediverse tagged #docusaurus, aggregated by home.social.
-
Note to self, don't update to #docusaurus 3.10.0, fiddly bug https://github.com/facebook/docusaurus/issues/11923
-
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
-
Ich hab für meine Studenten einen kleinen #Docusaurus aufgesetzt. Feedback gern willkommen. https://winfprojekt.de/
-
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
-
Deze week weer hard gewerkt aan #UitBetrouwbareBron content. Voorbeelden van hoe een betrouwbare bron in elkaar zou moeten zitten ... (en dan hard 'vechten' met historie en bi-temporal projecties ... visualiseren 🤯 ... en dat met #Docusaurus en #React ... Wat ben ik blij met een #ClaudeCode accountje, zeg! 😄 )
-
-
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!
-
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.
-
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
-
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
-
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
-
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
-
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“ 😕
-
🎭 Spectacular 17.0 release
- Require #Angular 17
- Support platform initializers in `createApplicationHarness`
- Recipe for platform initializers in documentation
- Documentation now uses #Docusaurus 3
#OpenSource #Testinghttps://github.com/ngworker/ngworker/releases/tag/spectacular-v17.0.0
-
Il plugin #Docusaurus gist aggiungeva una pagina all'istanza di Docusaurus, mostrando tutti i gist pubblici degli utenti GitHub che lo usano
Le versioni di docusaurus-plugin-content-gists precedenti alla 4.0.0 sono vulnerabili all'esposizione dei token di accesso personale GitHub negli artefatti di build di produzione quando vengono passati attraverso le opzioni di configurazione del plugin. Il token, destinato esclusivamente all'accesso API in fase di build, viene inavvertitamente incluso nei bundle JavaScript lato client, rendendolo accessibile a chiunque possa visualizzare il codice sorgente del sito web. Questa vulnerabilità è stata risolta nella versione 4.0.0.
-
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.
-
Ускоряем документацию в 10 раз
Исправить опечатку в документации занимало 5 минут компиляции. Страницы с картинками загружались медленно. Я считаю, чтобы посмотреть документацию не нужен JavaScript. Расскажу как переехал с docusaurus + react на starlight + astro и оптимизировал сайт под экологию.
-
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
-
@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).
-
🌟 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 -
@niklaskorz Not yet. We have a large releases.yml file in an internal repo, accompanied by some tooling that generates the md files for https://docs.opentalk.eu/releases/. I'd love to generate machine-readable data for the public, but this hasn't happened so far. Generating JSON (or other format) files would be the easy part. The difficult part is teaching #Docusaurus that we really do want to publish them as assets. Did I already mention how much I love Docusaurus? Another thing that was there before me…
-
Ah yes, the riveting tale of "Starlight vs. #Docusaurus," where the climax is... a #documentation software #switch. 😴 If you relish the thrill of swapping one open-source tool for another, this is your literary Everest. 🏔️ Or just press Ctrl+F for "why" and have a laugh. 😂
https://glasskube.dev/blog/distr-docs/ #Starlight #OpenSource #TechHumor #HackerNews #ngated -
Comparing Docusaurus and Starlight and why we made the switch
https://glasskube.dev/blog/distr-docs/
#HackerNews #Docusaurus #Starlight #Documentation #Switch #TechBlog
-
-
@lsmith #Docusaurus powers the @bitexpert blog and I like it.
-
i redit my homepage because it was worse.
https://positive-intentions.com
i was going for "warm and inviting". let me know what you think. i guess the purpose of the homepage is to guide people to more information about the projects.
im wondering about if i should replace all the images for some AI image-gen to make it seem more professional.
-
Does anyone have any experience with #docusaurus in multi-repository setup? More in 🧵
#javascript #devx -
#bitBlog Adding Klaro! Consent Manager to #Docusaurus https://blog.bitexpert.de/blog/docusaurus_klaro_consent_manager
-
🚀 We’ve revamped our API documentation on the help site. It's got all the info to get you started on passbolt's API and the developer guide covers the big-picture stuff.
Shoutout to #Redocly and #Docusaurus for helping us build a sleek, DIY, easy-to-navigate experience.Explore the documentation and let us know what you think! ➡️ https://hubs.li/Q02QgS2k0
-
Well that was a struggle, but finally managed to deploy a Docusaurus test site via GitHub pages and set up a workflow to update it. Bring on the l33t. #docusaurus #github
-
Has anyone tried using #writerside yet? It's part of my #Jetbrains subscription and I'm considering trying it out to see if it makes it any easier to write documentation. My main concern is that it may make it harder for others who want to contribute to the docs.
Currently I'm using #docusaurus with mixed results. It's like a #React wrapper for markdown docs.
-
Docusaurus is a great static website builder but is lacking a good publishing workflow (like all static website builders, I guess). In my blog post, I've outlined our current publishing process https://blog.bitexpert.de/blog/our_docusaurus_publishing_workflow
-
🚀 We’ve revamped our API documentation on the help site. It's got all the info to get you started on passbolt's API and the developer guide covers the big-picture stuff.
Shoutout to #Redocly and #Docusaurus for helping us build a sleek, DIY, easy-to-navigate experience.Explore the documentation and let us know what you think! ➡️ https://hubs.li/Q02QgS2k0
-
🚀 We’ve revamped our API documentation on the help site. It's got all the info to get you started on passbolt's API and the developer guide covers the big-picture stuff.
Shoutout to #Redocly and #Docusaurus for helping us build a sleek, DIY, easy-to-navigate experience.Explore the documentation and let us know what you think! ➡️ https://hubs.li/Q02QgS2k0
-
🚀 We’ve revamped our API documentation on the help site. It's got all the info to get you started on passbolt's API and the developer guide covers the big-picture stuff.
Shoutout to #Redocly and #Docusaurus for helping us build a sleek, DIY, easy-to-navigate experience.Explore the documentation and let us know what you think! ➡️ https://hubs.li/Q02QgS2k0
-
🚀 We’ve revamped our API documentation on the help site. It's got all the info to get you started on passbolt's API and the developer guide covers the big-picture stuff.
Shoutout to #Redocly and #Docusaurus for helping us build a sleek, DIY, easy-to-navigate experience.Explore the documentation and let us know what you think! ➡️ https://hubs.li/Q02QgS2k0
-
Crazy workflow trying to embed an image carousel in #docusaurus! Uploaded to #archive.org, used #iframely to generate an iframe and then #transform.tools to turn the #html into #jsx – after all that, results not that great :( https://jsvdw-docusaurus.vercel.app/blog/2009/03/16/pictures-from-bare-wires
-
My top 3 wishes for #Docusaurus:
1. Ability to fetch the link title from the target doc, rather than entering it manually: [Link Title](./target.md) When a page gets renamed, fixing up links is tedious and easy to forget.
2. Automatically convert "" and -- to “” and —. remark-smartypants can do it, but doesn't seem to work with Docusaurus. (?)
3. Support #rspack for much faster builds. Docusaurus bundling is slowww even for relatively small projects.
-
We've created a copy of the #Mozhi #keyboard layout (@[email protected]) #documentation using @[email protected]. #Malayalam translation is yet to do! #keyman #docusaurus #digitalmalayali
👇
https://mozhi-documentation.digitalmalayali.in/
