@sfdocs-internal/api-documentation-document
Advanced tools
A component to render documentation node of the AMF model
This component is being deprecated. The code base has been moved to api-documentation module. This module will be archived when PR 37 is merged.
A component to render documentation node of the AMF model
<api-documentation-document amf="{...}" shape="{...}"></api-documentation-document>
This version only works with AMF model version 2 (AMF parser >= 4.0.0).
For compatibility with previous model version use 3.x.x version of the component.
npm install --save @api-components/api-documentation-document
<html>
<head>
<script type="module">
import '@api-components/api-documentation-document/api-documentation-document.js';
</script>
</head>
<body>
<api-documentation-document></api-documentation-document>
</body>
</html>
import { LitElement, html } from 'lit-element';
import '@api-components/api-documentation-document/api-documentation-document.js';
class SampleElement extends PolymerElement {
render() {
return html`
<api-documentation-document .amf="${this.amf}"></api-documentation-document>
`;
}
}
customElements.define('sample-element', SampleElement);
git clone https://github.com/advanced-rest-client/api-documentation-document
cd api-documentation-document
npm install
npm start
npm test
This components is a part of API components ecosystem
FAQs
A component to render documentation node of the AMF model
We found that @sfdocs-internal/api-documentation-document demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 14 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.
Product
Socket Firewall Enterprise is now available with flexible deployment, configurable policies, and expanded language support.
Security News
Open source dashboard CNAPulse tracks CVE Numbering Authorities’ publishing activity, highlighting trends and transparency across the CVE ecosystem.
Product
Detect malware, unsafe data flows, and license issues in GitHub Actions with Socket’s new workflow scanning support.