This packages is a collection of React / MDX Components to render content to Web (Airview), PDF (Airview) and Presentations (MDX-Deck).
npm install airview-mdxThis packages is a collection of React / MDX Components to render content to Web (Airview), PDF (Airview) and Presentations (MDX-Deck).
Storybook is used to documenbt these components in a standalone location..
Each component should have a dedicated .tsx file within src/stories. it should also have a .stories.tsx to describe the Component in Storybook. Optionally a .mdx can be used to document the Component in further detail if required.
First, install dependancies:
``bash`
npm i
The run storybook:
`bash`
npm run storybook
Open http://localhost:6006 with your browser to see the result.
Commit messages should use Conventional Commits. See here for further detail.
The Conventional Commits specification is a lightweight convention on top of commit messages.
It provides an easy set of rules for creating an explicit commit history;
which makes it easier to write automated tools on top of.
This convention dovetails with SemVer,
by describing the features, fixes, and breaking changes made in commit messages.
The commit message should be structured as follows:
---
`
[optional body]
[optional footer(s)]
`
---
The commit contains the following structural elements, to communicate intent to the
consumers of your library:
1. fix: a commit of the _type_ fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).feat
1. feat: a commit of the _type_ introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).BREAKING CHANGE:
1. BREAKING CHANGE: a commit that has a footer , or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning).fix:
A BREAKING CHANGE can be part of commits of any _type_.
1. _types_ other than and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:,ci:
, docs:, style:, refactor:, perf:, test:, and others.BREAKING CHANGE:
1. _footers_ other than may be provided and follow a convention similar to
git trailer format.
Additional types are not mandated by the Conventional Commits specification, and have no implicit effect in Semantic Versioning (unless they include a BREAKING CHANGE).
A scope may be provided to a commit's type, to provide additional contextual information and is contained within parenthesis, e.g., feat(parser): add ability to parse arrays.
feat: allow provided config object to extend other configsBREAKING CHANGE:
key in config file is now used for extending other config files
`$3
feat!: send an email to the customer when a product is shipped
$3
feat(api)!: send an email to the customer when a product is shipped
$3
chore!: drop support for Node 6BREAKING CHANGE: use JavaScript features not available in Node 6.
$3
docs: correct spelling of CHANGELOG
$3
feat(lang): add Polish language
$3
fix: prevent racing of requestsIntroduce a request id and a reference to latest request. Dismiss
incoming responses other than from latest request.
Remove timeouts which were used to mitigate the racing issue but are
obsolete now.
Reviewed-by: Z
Refs: #123