New Research: Supply Chain Attack on Axios Pulls Malicious Dependency from npm.Details →
Socket
Book a DemoSign in
Socket

ppn-api-documentation

Package Overview
Dependencies
Maintainers
1
Versions
35
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

ppn-api-documentation

Priceline Partner Network Documentation

latest
Source
npmnpm
Version
1.0.34
Version published
Maintainers
1
Created
Source

PPN API Documentation

Content used for Priceline Partner Network's developer website.

Here's how it works:

Running an npm run build will trigger the build script.

The build script will scan the src directory for herodotus.config.js files. This is just a data mapping file. You can stick whatever information, formatted however you want inside of it. The default export of the file should be an object that contains a unique ID found in the project.

All the herodotus.config.js files will then be combined, transpiled, and bundled together as a library using webpack. The library modules are divided into files using the ID of the herodotus.config.js file as the filename.

Writing Documentation

Simply write an MD file and register it to a herodotus.config.js file. Every herodotus.config.js file acts as an entry point into compiling the documentation. Your project can then parse this information however it wants to be display.

FAQs

Package last updated on 20 Dec 2019

Did you know?

Socket

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

Related posts