typedoc-plugin-markdown icon indicating copy to clipboard operation
typedoc-plugin-markdown copied to clipboard

Feature: Add command to generate markdown files for docusaurus

Open edgardmessias opened this issue 3 years ago • 0 comments
trafficstars

Hi, I would like to create a docusaurus command to generate the markdown files only. Internally I did that, but the objective of this issue is to improve the options before making a PR.

I have a scenario that I put the markdown files on GitHub and I create a workflow to publish after pushes to main. There are some externals repositories that I would like to generate new markdown files when I release a new version, and using a special command, I can geneate the new markdown files and send to docusaurus site.

Command suggestion: npx docusaurus typedoc [args] <options> Suggested options:

  • [args] optional, but I can pass the IDs that I would like to run
  • --watch: Set watch mode
  • <some typedoc options>

Last but not least, I recomend to create a plugin option to "disable" while I am using docusaurus start/build, but still avaiable to run from command

edgardmessias avatar Mar 08 '22 11:03 edgardmessias