Search Results for "cli"

TypeDoc converts comments in TypeScript source code into rendered HTML documentation or a JSON model. It is extensible and supports a variety of configurations. Available as a CLI or Node module. TypeDoc requires Node.js to be installed on your system. Installing TypeDoc is available as a node package. Using npm ensures that all relevant dependencies are setup correctly. You can choose to either install locally to your project or globally to the CLI. TypeDoc aims to support the two latest TypeScript releases for the latest release. ...

react-docgen is a CLI and toolbox to help extracting information from React components, and generate documentation from it. It uses @babel/parser to parse the source into an AST and provides methods to process this AST to extract the desired information. The output / return value is a JSON blob / JavaScript object. It provides a default implementation for React components defined via React.createClass, ES2015 class definitions or functions (stateless components).

Redoc is an open source tool for generating documentation from OpenAPI (formerly Swagger) definitions. With Redoc, you can generate beautiful API documentation from OpenAPI. Redoc is provided as a CLI tool (also distributed as a Docker image), HTML tag, and React component. If you have Node installed, quickly generate documentation using npx. Open the HTML file in your browser, and your API documentation is shown on the page. Redoc is highly configurable. Redoc offers OpenAPI specification extensions.

...See how components behave to different props and data right in the browser. vue-styleguidist takes the results of vue-docgen-api and creates a website to showcase and develop components. vue-docgen-api parses vue components and load their documentation in a JavaScript object. vue-inbrowser-compiler takes vue components code written in es6 and uses buble to make it compatible with all browser. vue-docgen-cli is a command line interface generating documentation files automatically from vue-docgen-api. Generate markdown by default but can be configured to generate whatever text format you desire.