@ngx-docs/api
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.6 • Public • Published

    @ngx-docs/api

    Angular 2+ components to create documentation on Angular Material.

    GitHub version npm version

    GitHub issues GitHub forks GitHub stars GitHub license

    Pros:

    • Component changeDetection is set to OnPush, it gives better overall performance.
    • Body key is header value, so it is possible to dynamically change table structure.

    Cons:

    • Need to change @Input() instance to have changes visible on template.
    • Tests are not ready yet.

    Image preview:

    Image preview


    Table of contents


    Demonstration

    Live demonstration

    Clone this repository:

    git clone https://github.com/ngx-docs/api.git

    Go to demo folder and by opening your command line do the following:

    npm i && npm start

    Open http://localhost:4200/ in your browser.

    Installation

    To install, run:

    npm install @ngx-docs/api --save

    Usage

    In your component file:

    import { Component } from '@angular/core';
     
    @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.scss']
    })
    export class AppComponent {
      title = 'app';
      description = `Markdown here is **working** too`;
      header = [
        'Name', 'Description'
      ];
      body: any = [
        {
          name: `markdown`,
          description: `You can use markdown code here like **bold** *italic*`
        }
      ];
    }

    In app.component.html write the following code:

    <ngx-docs-api
      [title]="title"
      [description]="description"
      [header]="header"
      [body]="body"
    ></ngx-docs-api>

    Style guide

    Angular style guide

    GIT

    Commit

    Versioning

    Semantic Versioning 2.0.0 http://semver.org/

    Given a version number MAJOR.MINOR.PATCH, increment the:
    MAJOR version when you make incompatible API changes,
    MINOR version when you add functionality in a backwards-compatible manner, and
    PATCH version when you make backwards-compatible bug fixes.
    Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

    FAQ
    How should I deal with revisions in the 0.y.z initial development phase?

    The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.

    How do I know when to release 1.0.0?

    If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.

    License

    MIT © ngx-docs

    Donate

    Click to donate

    Keywords

    Install

    npm i @ngx-docs/api

    DownloadsWeekly Downloads

    5

    Version

    0.1.6

    License

    MIT

    Last publish

    Collaborators

    • ngxpackage