https://github.com/tangrams/tangram-docs-library

NPM module for Tangram Documentation
https://github.com/tangrams/tangram-docs-library

Last synced: 12 months ago
JSON representation

NPM module for Tangram Documentation

• Host: GitHub
• URL: https://github.com/tangrams/tangram-docs-library
• Owner: tangrams
• Created: 2016-08-16T21:32:21.000Z (almost 10 years ago)
• Default Branch: gh-pages
• Last Pushed: 2016-08-26T17:10:48.000Z (almost 10 years ago)
• Last Synced: 2025-06-06T15:06:45.179Z (about 1 year ago)
• Language: JavaScript
• Homepage: https://tangrams.github.io/tangram-docs-api/documentation/scene.yaml
• Size: 24.4 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Tangram Documentation Library

NPM library Prototype: [https://www.npmjs.com/package/tangram-docs](https://www.npmjs.com/package/tangram-docs)

## Documentation folder

Contains the yaml files that specify information for each Tangram parameter

## Tangram-docs folder

This is where our library lives.

The `source/app.js` file contains a script that has to be run to generate the `dist/tangram-docs.json` file. To run simply type:

`node app.js`

The script will crawl through the `documentation/` folder and generate a .json file based on all the Tangram parameter specs.

The `dist/` folder contains library functions to interact and fetch information from the .json file.