devdocs-client
A JavaScript client for the devdocs.io JSON API.
Installation
$ npm install devdocs-client
Usage
const devdocs = ; devdocs ;
Endpoints
Available Docs
Lists available documentation.
GET https://devdocs.io/docs/docs.json
name: 'JavaScript' slug: 'javascript' type: 'mdn' mtime: 1534718903 db_size: 5793848 ...
Slug Metadata
Gets metadata for a slug.
GET https://docs.devdocs.io/{slug}/meta.json
name: 'JavaScript' slug: 'javascript' type: 'mdn' mtime: 1534718903 db_size: 5793848
Slug Index
Gets entries and types for a slug.
GET https://docs.devdocs.io/{slug}/index.json
entries: name: '!' path: 'operators/logical_operators#Logical_NOT' type: 'Operators' ... types: name: 'Array' count: 40 slug: 'array' ...
Slug Docs
Gets documentation for a slug.
GET https://docs.devdocs.io/{slug}/db.json
'statements/const': '<h1>const</h1> Constants are block-scoped, much like...' ...
Contributing
See: CONTRIBUTING.md
License (ISC)
In case you never heard about the ISC license it is functionally equivalent to the MIT license.
See: LICENCE.md