@condenast/ember-docs
Advanced tools
:warning: This library is in progress and shouldn't be used quite yet. :warning:
ember-docs is a library to generate better documentation for Ember applications, using Ember's strong conventions to enhance JSDoc.
npm install @condenast/ember-docs
Ember has strong conventions, so we wanted to bring those conventions to writing documentation for Ember apps and Ember addons. Since the conventions are so strong, we can remove a lot of requirements of documentation engines and pull the information directly from code.
:point_right: No need to name files or define access on them.
app/helpers/equals.jsis automatically detected as a public helper namedequalsbecause it's in the correct spot for an Ember helper.
app/helpers/-in-element.jsis detected as a private helper because of the preceding-.
:point_right: No need to duplicate parameter structure in components & helpers.
Positional and named parameters are pulled from component and helper definitions and provided for you.
:point_right: Defaults are pulled from code
Default parameters are pulled from the code so you don't need to to define them twice. (Yes, you can override this)
FAQs
Creates documentation from Ember apps / addons
The npm package @condenast/ember-docs receives a total of 70 weekly downloads. As such, @condenast/ember-docs popularity was classified as not popular.
We found that @condenast/ember-docs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 293 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.
Security News
The Axios compromise shows how time-dependent dependency resolution makes exposure harder to detect and contain.
Research
A supply chain attack on Axios introduced a malicious dependency, plain-crypto-js@4.2.1, published minutes earlier and absent from the project’s GitHub releases.