Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/advanced-rest-client/api-documentation-document
⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.
https://github.com/advanced-rest-client/api-documentation-document
deprecated obselete
Last synced: about 1 month ago
JSON representation
⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.
- Host: GitHub
- URL: https://github.com/advanced-rest-client/api-documentation-document
- Owner: advanced-rest-client
- Created: 2018-04-13T01:25:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:57:11.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T21:18:37.037Z (8 months ago)
- Topics: deprecated, obselete
- Language: JavaScript
- Homepage:
- Size: 1.53 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DEPRECATED
This component is being deprecated. The code base has been moved to [api-documentation](https://github.com/advanced-rest-client/api-documentation) module. This module will be archived when [PR 37](https://github.com/advanced-rest-client/api-documentation/pull/37) is merged.
-----
A component to render documentation node of the AMF model
```html
```
## Version compatibility
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.## Usage
### Installation
```ssh
npm install --save @api-components/api-documentation-document
```### In an html file
```html
import '@api-components/api-documentation-document/api-documentation-document.js';
```
### In a LitElement
```js
import { LitElement, html } from 'lit-element';
import '@api-components/api-documentation-document/api-documentation-document.js';class SampleElement extends PolymerElement {
render() {
return html`
`;
}
}
customElements.define('sample-element', SampleElement);
```## Development
```sh
git clone https://github.com/advanced-rest-client/api-documentation-document
cd api-documentation-document
npm install
```### Running the demo locally
```sh
npm start
```### Running the tests
```sh
npm test
```## API components
This components is a part of [API components ecosystem](https://elements.advancedrestclient.com/)