Skip to content

Commit

Permalink
Add JSDocs Page and Script
Browse files Browse the repository at this point in the history
Includes new script `npm run doc` for generating docs page.
  • Loading branch information
danfinlay committed Apr 12, 2018
1 parent 29dab1e commit 136caa2
Show file tree
Hide file tree
Showing 21 changed files with 4,681 additions and 61 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# MetaMask Browser Extension
[![Build Status](https://circleci.com/gh/MetaMask/metamask-extension.svg?style=shield&circle-token=a1ddcf3cd38e29267f254c9c59d556d513e3a1fd)](https://circleci.com/gh/MetaMask/metamask-extension) [![Coverage Status](https://coveralls.io/repos/github/MetaMask/metamask-extension/badge.svg?branch=master)](https://coveralls.io/github/MetaMask/metamask-extension?branch=master) [![Greenkeeper badge](https://badges.greenkeeper.io/MetaMask/metamask-extension.svg)](https://greenkeeper.io/) [![Stories in Ready](https://badge.waffle.io/MetaMask/metamask-extension.png?label=in%20progress&title=waffle.io)](https://waffle.io/MetaMask/metamask-extension)

[Internal documentation](./docs/jsdocs)

## Support

Expand Down
25 changes: 25 additions & 0 deletions development/tools/.jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"tags": {
"allowUnknownTags": false
},
"source": {
"include": "app/scripts/",
"includePattern": ".js$",
"excludePattern": "(node_modules/|docs)"
},
"plugins": [
"plugins/markdown"
],
"opts": {
"template": "node_modules/radgrad-jsdoc-template/",
"encoding": "utf8",
"destination": "docs/jsdocs",
"recurse": true,
"verbose": true
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false
}
}

15 changes: 15 additions & 0 deletions development/tools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Development Tools & Configurations

This folder contains configuration files which are used by the the different
development-tools, like e.g. JsDoc.


## Appveyor


https://www.appveyor.com/docs/build-configuration/#alternative-yaml-file-location

Withtin the configuration, point to a weblocation of a txt config file:

https://ci.appveyor.com/project/lazaridiscom/mm-vault/settings
https://raw.githubusercontent.com/lazaridiscom/mm-vault/master/dev/tools/appveyor.txt
21 changes: 21 additions & 0 deletions development/tools/appveyor.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Test against the latest version of this Node.js version
environment:
nodejs_version: "8"

# Install scripts. (runs after repo cloning)
install:
# Get the latest stable version of Node.js or io.js
- ps: Install-Product node $env:nodejs_version
# install modules
- npm install

# Post-install test scripts.
test_script:
# Output useful info for debugging.
- node --version
- npm --version
# run tests
- npm test

# Don't actually build.
build: off
Loading

0 comments on commit 136caa2

Please sign in to comment.