Comments (17)
If anyone else comes to this, you should do something like this for your configuration, and it works pretty well:
{
"source": "./src",
"destination": "./doc",
"includes": [".*\\.js", ".*\\.jsx"],
"index": "./README.md",
"package": "./package.json",
"experimentalProposal": {
"classProperties": true,
"objectRestSpread": true
}
}
from esdoc.
Sorry, for now, I do not plan that support JSX 😓
from esdoc.
@h13i32maru alright. would be interested in PR with it? maybe I'll fork and try to implement it myself :)
from esdoc.
@yamalight I am not interested in the PR. Because I am not using JSX and can not maintain it. I welcome that you fork and implement it!
from esdoc.
@h13i32maru alright, fair enough. thanks for responses :)
from esdoc.
@yamalight ESDoc supported JSX!
I had thought the support of JSX is difficult. However, espree already supports JSX.
Sorry, I was careless 💦
from esdoc.
ah, cool. I'll try to use it on my jsx code once more and will report if there are any issues 👍
from esdoc.
@yamalight Any news?
from esdoc.
@resistdesign no issues so far, works great
from esdoc.
@yamalight Does it auto-doc your props based on static propTypes
?
from esdoc.
@resistdesign no, it doesn't have any jsx specific functions (although that does sounds pretty cool)
from esdoc.
@resistdesign Still getting an error when trying to parse jsx. Not sure what @yamalight solution to this was.
from esdoc.
@realmike33 I haven't tried in a while, been handling other stuff for now.
from esdoc.
@yamalight would you mind sharing an example of some jsx annotated with esdoc tag?
from esdoc.
@jarzuaga I'm just using it normally within react projects (generating docs for react classes) - seems to work just fine without any additional tweaks.
from esdoc.
Gotcha, thought you were annotating the JSX in some way and got curious. Thanks @yamalight !
from esdoc.
now youre need to use plugin instead
from esdoc.
Related Issues (20)
- @returns v.s @return - ambiguity causes inconsistency HOT 3
- Bug: Magically infer the return data type of a function is not working correctly.
- Make esdoc responsive on mobile
- Defining Identifies
- Outdated website / docs HOT 4
- Project Dead? HOT 18
- Add support for asciidoc manuals
- rewrite links: .md -> .html
- Table of Contents rendering with display: none
- import.meta.url will throw an error
- Linked markdown files in README don't get HTMLized, so get lost in documentation
- Cannot read property 'program' of undefined HOT 1
- @type description after dot is ignored/removed in docs
- please consider supporting the @readonly tag
- How to disable doc for just a line
- runtime error
- Can't parse private members of classes
- Can't parse `||=` operator. HOT 1
- Documenting events?
- Dependency ice-cap isn't maintained
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 esdoc.