javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-18 19:21:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs wip

Browse Source
This commit is contained in:
Tim Lancina
2015-08-27 12:39:15 -07:00
parent 327c6de125
commit a59469eae6
3 changed files with 21 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
scripts/docs/dgeni-config.js
View File

@ -9,8 +9,19 @@ var path = require('path');
// Define the dgeni package for generating the docs // Define the dgeni package for generating the docs
module.exports = new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage, gitPackage]) module.exports = new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage, gitPackage])
//for debugging docs
// .processor(function test(){
// return {
// $runAfter: ['files-written'],
// $process: function(docs){
// docs.forEach(function(doc){
// })
// }
// }
// })
.config(function(log) { .config(function(log) {
log.level = 'silly' //'warn'; log.level = 'error'; //'silly', 'debug', 'info', 'warn', 'error'
}) })
.config(function(renderDocsProcessor, versionInfo) { .config(function(renderDocsProcessor, versionInfo) {
@ -22,19 +33,11 @@ module.exports = new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, ty
// Don't run unwanted processors // Don't run unwanted processors
readFilesProcessor.$enabled = false; // We are not using the normal file reading processor readFilesProcessor.$enabled = false; // We are not using the normal file reading processor
// inlineTagProcessor.$enabled = false; // We are not actually processing the inline link tags
// jsdocFileReader.defaultPattern = /\.(j|t)s$/;
// readFilesProcessor.fileReaders = [jsdocFileReader];
readFilesProcessor.basePath = path.resolve(__dirname, '../..'); readFilesProcessor.basePath = path.resolve(__dirname, '../..');
readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, '../..')); readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, '../..'));
// readFilesProcessor.sourceFiles = [
// { include: 'ionic/**/*.ts', basePath: 'ionic' }
// ]
readTypeScriptModules.sourceFiles = [ readTypeScriptModules.sourceFiles = [
'ionic/ionic.ts' 'ionic/ionic.ts'
]; ];
readTypeScriptModules.hidePrivateMembers = true;
}) })
.config(function(parseTagsProcessor) { .config(function(parseTagsProcessor) {
@ -70,7 +73,10 @@ module.exports = new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, ty
// Specify how to match docs to templates. // Specify how to match docs to templates.
// In this case we just use the same static template for all docs // In this case we just use the same static template for all docs
templateFinder.templatePatterns.unshift('common.template.html'); templateFinder.templatePatterns = [
'${ doc.docType }.template.html',
'common.template.html'
]
// templateFinder.templatePatterns = [ // templateFinder.templatePatterns = [
// '${ doc.template }', // '${ doc.template }',

1
scripts/docs/links-package/index.js
View File

@ -8,6 +8,5 @@ module.exports = new Package('links', [])
.factory(require('./services/getLinkInfo')) .factory(require('./services/getLinkInfo'))
.config(function(inlineTagProcessor, linkInlineTagDef) { .config(function(inlineTagProcessor, linkInlineTagDef) {
debugger;
inlineTagProcessor.inlineTagDefinitions.push(linkInlineTagDef); inlineTagProcessor.inlineTagDefinitions.push(linkInlineTagDef);
}); });

5
scripts/docs/templates/module.template.html vendored Normal file
View File

@ -0,0 +1,5 @@
<h1>{$ doc.id $}</h1>
{%- for export in doc.exports %}
<a href="/docs/{$ export.outputPath $}">{$ export.name $}</a>
{% endfor %}