Possible website rebuild #10
Replies: 2 comments 1 reply
-
Just chiming in that I really like this suggestion. For my tool/package documentation sites, I've had great success with markdown as the source format. In particular, I've used both the Hugo generator (with the relearn theme) as well as the Quarto publishing system with great success. Having a little link on each page that takes the viewer directly to the source file on GitHub would be a great friction-less way to get additional contributions. |
Beta Was this translation helpful? Give feedback.
-
It's been an extremely useful feature for my sites at the day job. Also here is a workshop site I built last year using the aforementioned Quarto and the edit links are in the right sidebar: https://posit-conf-2023.github.io/shiny-r-prod/ |
Beta Was this translation helpful? Give feedback.
-
Right now, Podcasting2.org is built with Next.js, which is a particular structure for React code. But I just learned about Starlight, which is a different structure for React code, created specifically for documentation websites.
What I like about it is that making and editing documentation could be as simple as almost pure markdown.
While this might mean ditching the current JSON structure for Podcast Namespace tag documentation, I might be able to build something that converts from markdown into JSON structured data through a RESTful API in case anyone needs it.
I'm only thinking about this now. I know Next.js better and I can do more with it, but making something easier for the community to edit would seem more important.
Beta Was this translation helpful? Give feedback.
All reactions