InlineDocs Component
The InlineDocs component lets you embed generated HTML documentation directly inside your Docusaurus site. It looks for the folder you provide as a parameter in the /documentation/static folder. That folder needs to have an index.html file in it, but most documentation generators do this for you.
You can commit the docs you generate whenever they are changed or create a Github Actions workflow to automatically move it for you.
Example
Props
| Name | Type | Default | Description |
|---|---|---|---|
docFolder | string | — | Folder name inside /static containing your generated HTML docs. |
width | string | "100%" | Width of the iframe. |
height | string | "600px" | Height of the iframe. |
Example Usage
Live Editor
<InlineDocs docFolder="sampleDocs" width="100%" height="600px" />
Result
Loading...
This looks for an index.html file in /documentation/static/sampleDocs then create a view with a width of 100% of its container and a height of 600 pixels.