@api-components/api-annotation-document

An element to render RAML annotations based on AMF data model

3.0.0-preview.2
Source
npm

Version published: 6 years ago

Weekly downloads: 293; decreased by-44.61%

Maintainers: 1

Weekly downloads

Created: 7 years ago

Source

<api-annotation-document>

An element to render RAML annotations based on AMF data model.

<api-annotation-document></api-annotation-document>

API components

This components is a part of API components ecosystem

Usage

Installation

npm install --save @api-components/api-annotation-document

In an html file

<html>
  <head>
    <script type="module">
      import '@api-components/api-annotation-document/api-annotation-document.js';
    </script>
  </head>
  <body>
    <api-annotation-document></api-annotation-document>
  </body>
</html>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@api-components/api-annotation-document/api-annotation-document.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
    <api-annotation-document></api-annotation-document>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Installation

git clone https://github.com/api-components/api-annotation-document
cd api-url-editor
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm

Keywords

FAQs

What is @api-components/api-annotation-document?

Is @api-components/api-annotation-document popular?

Is @api-components/api-annotation-document well maintained?

Package last updated on 26 Mar 2019

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.

Install