Skip to content

Commit a439f00

Browse files
committed
copying default jsdoc template for modifications
1 parent 53b36f6 commit a439f00

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+13374
-2
lines changed

.npmignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ examples
1212
LICENSE
1313
CONTRIBUTING.md
1414
RELEASE.md
15-
.jsdoc.json
15+
jsdoc/
16+
doc/

.jsdoc.json renamed to jsdoc/config.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
},
55
"opts": {
66
"package": "package.json",
7+
"readme": "README.md",
78
"recurse": true,
9+
"template": "jsdoc/template",
810
"destination": "./doc/"
911
}
1012
}

jsdoc/template/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://documentcloud.github.com/underscore/#template).
2+
3+
4+
## Generating Typeface Fonts
5+
6+
The default template uses the [OpenSans](https://www.google.com/fonts/specimen/Open+Sans) typeface. The font files can be regenerated as follows:
7+
8+
1. Open the [OpenSans page at Font Squirrel](<http://www.fontsquirrel.com/fonts/open-sans>).
9+
2. Click on the 'Webfont Kit' tab.
10+
3. Either leave the subset drop-down as 'Western Latin (Default)', or, if we decide we need more glyphs, than change it to 'No Subsetting'.
11+
4. Click the 'DOWNLOAD @FONT-FACE KIT' button.
12+
5. For each typeface variant we plan to use, copy the 'eot', 'svg' and 'woff' files into the 'templates/default/static/fonts' directory.

0 commit comments

Comments
 (0)