ink-elements

    2.0.1 • Public • Published

    Ink Elements Build Status

    Custom elements for publishing documents via HTML and CSS. Requires use of paged.js Paged Media polyfill.

    Demo

    Check it live!

    Install

    Install the component:

    $ npm install ink-elements --save

    Or download as ZIP.

    Usage

    1. Import polyfills:
    <script src="https://unpkg.com/pagedjs/dist/paged.polyfill.js"></script>
    <script src="node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>
    1. Import custom element:
    <script type="module" src="node_modules/ink-elements/ink-page-xref.js"></script>
    1. Start using it!
    <p>See page <ink-page-xref ref="html-id"></ink-page-xref> for more information.</p>;

    Development

    In order to run, test and modify this project locally you'll need to follow these steps:

    1. Install pre-requisites for Polymer CLI (git, npm, Node.js).

      Full instructions are on the Polymer website..

    2. Install Polymer CLI:

      npm install -g polymer-cli@next
      

      Full instructions are on the Polymer website..

    3. Clone this repo:

      git clone https://github.com/ink-elements/ink-elements.git
      
    4. Change directory to the top-level project folder and install project dependencies:

      cd ink-elements
      npm install
      
    5. To preview your element, run the Polymer development server from the top-level project folder:

      polymer serve --open
      
    6. To verify code style run:

      yarn build
      

    License

    MIT License

    Install

    npm i ink-elements

    DownloadsWeekly Downloads

    0

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    8.82 kB

    Total Files

    10

    Last publish

    Collaborators

    • rgladwell