DEV Community

Cover image for Build Documentation Engine in Typescript which should be a framework independent(ReactJS).
QUDDUS
QUDDUS

Posted on

Build Documentation Engine in Typescript which should be a framework independent(ReactJS).

I am working on documentation engine that should be Framework independent on React.js means developer can easily align docxes with any framework like NextJS. remix, astro, vite react, or express etc.

Why I take this Action?

I had been changing my old Documentation from next to remix for 3-4.But, I had faced many problems.The biggest is to support of MDX and traditional engine limitations in remix and then I choose Astro.js also shows many limitations.

I accept these framework are support MDX but, not in optimized way, some other complexity in development ways or learning curve that makes me to do different code in different ReactJS frameworks.

I think it become easy for use when an engine provide pre build docs, sidebar items in semi structured and table of contents automatically by scanning any folder that contains folder and MDX files.

I relatively complete this but, I t have failed at highlighter and tables in markdowns. it is mainly tested with NextJS.

I just need some contribution that helps to grow innovative Markdown engine and provide scalable engine at PaaS Industries.

  1. You can Contribute with me through: Docxes Repository

  2. You can also see a documentation built with docxes in NextJS. Docxes Docs

Top comments (0)