NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
458 stars 102 forks source link

error in Docusaurus guide #177

Closed Benedict-Carling closed 3 years ago

Benedict-Carling commented 3 years ago

In the page: https://github.com/NiklasRosenstein/pydoc-markdown/tree/develop/examples/docusaurus

It says to use the line in sidebar.js

module.exports = {
  someSidebar: {
    "API Documentation": require("./docs/reference/sidebar.json"),
    Docusaurus: ['doc1', 'doc2', 'doc3'],
    Features: ['mdx'],
  },
};

However in your code you used

module.exports = {
  someSidebar: {
    "API Documentation": [
      require("./docs/reference/sidebar.json")
    ],
    Docusaurus: ['doc1', 'doc2', 'doc3'],
    Features: ['mdx'],
  },
};

Only the latter works, it would be useful for others to update the guide to stop making the same mistake.

Best, Benedict

NiklasRosenstein commented 3 years ago

Hey @Benedict-Carling , thanks for the info. Fixed in 25e9511bf9b8e96caf589f62817445e8c0f6ccef :)