I'll try Docusaurus then! Thanks for the recommendation, Lari!. > Are you planning to target the https://github.com/apache/hunter-website > repository with these PRs ?
I would prefer to split the README into markdown documentation files in apache/hunter to focus on the overall content, then port it over to hunter-website as Docusaurus files focusing on the MDX and nice formatting. Best, Alex On Tue, Dec 10, 2024 at 5:31 AM Lari Hotari <lhot...@apache.org> wrote: > On 2024/12/08 22:52:06 Alexander Sorokoumov wrote: > > I do not have any preference at the moment as I haven’t worked yet with > any > > of the discussed options. > > If there's no preference, I'd recommend Docusaurus since it is easy to > work with and extends to any sorts of websites. The content in Docusaurus > is in MDX format [1] which allows using React components when that makes > sense. For example in Pulsar, we have a supported versions [2] table that > is time based. The download page [3] also uses some dynamic components. MDX > format is markdown based. Most markdown documents are valid MDX documents. > There's only a few exception cases where certain characters in the content > need to be escaped. MDX in Docusaurus supports many plugins such as > automatic syntax highlighters for code blocks and rendering math > expressions with KaTeX [4]. > > 1 - https://mdxjs.com/ > 2 - > https://pulsar.apache.org/contribute/release-policy/#supported-versions > 3 - https://pulsar.apache.org/download/ > 4 - https://katex.org/ > > > As Henrik mentioned above, I have been working on refactoring existing > > Hunter docs into multiple pages covering different importers, exporters, > > individual features, etc. My plan is to replace the “examples” folder > with > > “docs” containing both documentation pages in markdown as well as > > reproducible examples with docker-compose. Then, either try to port these > > pages to different documentation engines and see/showcase what seems to > > work better or use the one we decide on in this thread. > > > > > > I hope to start opening docs PRs in markdown by the end of next week, in > > case we finish with setting up apache/hunter. > > Are you planning to target the https://github.com/apache/hunter-website > repository with these PRs ? > > -Lari >
