npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

edc-web-publishing-js

v1.1.4-deprecated

Published

edc-web-publishing-js

Downloads

2

Readme

edc help client

DEPRECATED: please use edc-client-js instead.

https://www.npmjs.com/package/edc-client-js

This project is meant to be used with easy doc contents (aka edc).

edc is a simple yet powerful tool for agile-like documentation management.

Learn more at https://www.easydoccontents.com.

Note

If you have an Angular, application you can use our edc help angular component available here :

https://github.com/tech-advantage/edc-popover-ng

Dependencies

No dependencies.

Installation

You can import your library with NPM in any Angular application by running:

$ npm install edc-web-publishing-js --save

with YARN, use:

$ yarn add edc-web-publishing-js

Usage

The edc help client has been made to be used with any web framework.

Instantiating a new EdcClient

To use the help client, you first have to instantiate a new EdcClient.

Below is an exemple for an Angular Typescript project, where exported documentation is served on /doc url :

this.edcClient = new EdcClient('/doc/');

Note that you can use ES6 imports to import classes from edc-web-publishinh-js :

import { EdcClient, Documentation, Helper, InformationMap } from 'edc-web-publishing-js';

Calling client

The edc help client expose several methods to get content :

  • getInfo()

Returns a promise containing the content of the info.json file from the export.

  • getContext()

Returns a promise containing the content of the context.json file from the export.

  • getToc(): Promise<Toc>

Returns a promise containing a table of content as Toc (see Toc object) representing the content of the toc.json file from the export.

edcClient.getToc().then(toc: Toc => this.toc = toc);
  • getHelper(mainKey, subKey): Promise<Helper>

Useful to get help content (see Helper object) for a particular key/subkey.

  • getDocumentation(idDocumentation): Promise<Documentation>

Useful to get help content (see Documentation object) for a particular documentation.

  • getInformationMapFromDocId(): Promise<InformationMap>

Useful to retrieve information map for a particular documentation.

See InformationMap.

  • getContent()

Will be private in next release.

  • getKey()

Will be private in next release.

More

If you want more information, you can check our Angular help component library using this edc help client :

https://github.com/tech-advantage/edc-popover-ng

License

MIT TECH'advantage