About

Doc-builder is a tool for generating documentation on the specification of ui component. The result of the generation is a markdown file containing examples of using the components.

Install

$ npm install --save-dev @eigenspace/doc-builder

or

$ yarn add --dev @eigenspace/doc-builder

How to use

There are 2 methods to generate documentation

1. Just call the method and pass as parameter the directories where the specification files are located or files, or both directories and files together.

       new DocGenerator().run(['src', 'src/spec.tsx']);

2. Run script index.js with params

       node node_modules/@eigenspace/doc-builder/index.js --src[]=src,src/spec.tsx

The generated example files will be located next to the specification files.

Why do we have that dependencies?

• @phenomnomnominal/tsquery - helps us parse specification.
• @eigenspace/argument-parser - used for parsing arguments when script running.
• @eigenspace/helper-scripts - common scripts for dev environment.

Why do we have that dev dependencies?

• @eigenspace/codestyle - includes lint rules, config for typescript.
• @types/* - contains type definitions for specific library.
• jest - testing framework to write unit specs (including snapshots).
• ts-jest - it lets you use Jest to test projects written in TypeScript.
• ts-loader - it is used to load typescript code with webpack.
• typescript - is a superset of JavaScript that have static type-checking and ECMAScript features. See webpack.config.js.
• webpack - it create app bundle for dev mode and production.
• copy-webpack-plugin - used for copy package.json in package bundle.
• eslint - it checks code for readability, maintainability, and functionality errors.
• clean-webpack-plugin - used for clean bundle before run building.
• husky - used for configure git hooks.
• lint-staged - used for configure linters against staged git files.
• prettier - style components formatter.
• webpack-cli - command line interface dor webpack.