diff --git a/docs/README.md b/docs/README.md index d66180fa..08728564 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,8 @@ # Vocdoni SDK Docs -Here you can generate the Vocdoni SDK documentation from the JSDocs annotations on the source code. It uses the package -[`jsdoc-to-mdx`](https://github.com/naver/jsdoc-to-mdx) that untherneath uses the well known `jsdoc-to-markdown` library. +Here you can generate the Vocdoni SDK documentation directly from the code using TypeDoc. It uses the package [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) to generate markdown files. -This library export the JSDocs to `.mdx` format, which is compatible with docusaurus instances. +This library exports the TypeDoc to `.md` format, which is compatible with docusaurus instances. ### How to generate the docs @@ -20,4 +19,4 @@ yarn build ``` This will generate a `temp_docs` folder with all generated documentation. It also copies de `../README.md` into -`temp_docs/sdk.md` to use it as docusaurus main page. \ No newline at end of file +`temp_docs/README.md` to use it as docusaurus main page. \ No newline at end of file