Comments (5)
jan-molak
commented on September 26, 2024
1
Works great, thanks @milesj!
from docusaurus-plugin-typedoc-api.
milesj
commented on September 26, 2024
This is very complicated at the moment.
Docusaurus renders these with MDX during build, while docblocks are rendering on the client using a markdown parser: https://github.com/milesj/docusaurus-plugin-typedoc-api/blob/master/packages/plugin/src/components/Markdown.tsx#L172
And since admonitions are not standard markdown, they are unsupported. I currently have no way to utilize MDX for these.
from docusaurus-plugin-typedoc-api.
jan-molak
commented on September 26, 2024
I wasn't sure how/if this could be done, so thanks for the explanation.
I wonder if we could use some extension to marked to bring in similar functionality 🤔
I found hs-marked-extra, but it's from 2016 so the likelihood it still works is rather slim.
from docusaurus-plugin-typedoc-api.
B4nan
commented on September 26, 2024
Maybe we could ask docusaurus guys to provide better extension points to support this? Same with the breadcrumbs (sorry, still havent had time to look into that myself and file an issue there).
from docusaurus-plugin-typedoc-api.
milesj
commented on September 26, 2024
Wrote my own parser to support this. 5e9bf5a
from docusaurus-plugin-typedoc-api.
Related Issues (20)
- Update Typedoc or make it a peer dependency? HOT 9
- Monorepo with a single package is broken after update to v3.0.1 HOT 4
- Next version of the docs is not rendered with v3.0.1 HOT 3
- Symbols are not rendered as links in versioned API docs in v3.0.1 HOT 1
- Support for Docusaurus v3 HOT 2
- Docusaurus build (production) fails because of ParseError HOT 3
- Weird issue with rendering categories (using `@category` tag) HOT 3
- `VersionBanner` "cannot read properties of undefined"
- Integration into Docusaurus Search HOT 1
- Integrate the sidebar into an existing sidebar HOT 3
- Github domain(githubHost) is `undefined` in Vercel HOT 4
- Support multi-version docs gen at the same time for the same api HOT 5
- [Question] Is there a way to modify the route slugs? HOT 3
- Custom path instead of /api HOT 4
- Disable API in versioned docs HOT 3
- Object literals and destructured parameters not rendering in docusaurus HOT 5
- Internal referance to the types/interfaces are not generated HOT 1
- [Question] Is there a way to show and hide `inheritedFrom` members using a toggle? HOT 1
- [Question] Support for a "Reference" section. HOT 1
- Docusaurus 3.5 HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docusaurus-plugin-typedoc-api.