basic example?

[jasonswearingen]

Hello, I'm trying to put together a basic example using the docusaurus workflow.

But something's not working with the typedoc MD generation, I get an index.md created, but no classes/enums/interfaces, and it doesn't seem to integrate properly with sidebars.json

what gets added to sidebars.json is:

  "undefined": {
    "Introduction": [
      "index"
    ],
    "External Modules": [
      "",
      "",
      "",
      "",
      "",
      ""
    ]
  }

and I'm not sure where the problem would be, maybe one of the following?:

• my code is missing something expected
• my typescript code have some definition breaking the typedoc-plugin-markdown
• wrong version of docusaurus
• misconfiguration of typedoc
• not working on windows
• something else?

So, having a basic example that I can get working and then customize seems neccesary. My example is pretty basic so far. I can post the code if needed, but probably quicker if a reference example can be created.

[jasonswearingen]

ok I figured my problem out, it's the same issue as #41 but with the new 2.0 codebase it error's silently and the output is corrupt.

I discovered this by trying v 1.2.1, getting the error of #41, then trying 2.x again with the same workaround.

So you should at minimum describe this.

I still haven't got docusaurus to see the doc output yet, but probably I need to rebuild the index or something (I am using docusarus for the first time also)

[jasonswearingen]

Though I think I got it working, for some reason the details injected into sidebars.json seem partially corrupted.

Here's an example of what was put into mine:

"undefined": {
    "Introduction": [
      "index"
    ],
    "External Modules": [
      "modules/__index_",
//etc etc etc....

• The root level is undefined instead of typedoc-plugin-markdown as the wiki says it should be.

• also the final subfolder (myapi in the wiki) is missing.

• and to get it to show up, you still need to edit siteConfig.js to show the proper headerLinks

After I moved the .md output to the base dir and added the entry to siteConfig.js it seems to work.

[tgreyuk]

@jasonswearingen I have created a simple repo with bare minimum example to get docusaurus up and running https://github.com/tgreyuk/typedoc-plugin-markdown-examples.

The root level should be the project name so for some reason it is not picking that up. If you could send the example you are trying to run I could have a look.

Thanks for having a look it is very much experimental at the moment. Please let me know how you get on with the above.

[jasonswearingen]

ok thank you, I will try again in a few days (my first try was a proof of concept). will reply back when I do.