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

have doc paths use version

Browse Source
This commit is contained in:
Tim Lancina
2015-09-01 11:50:16 -05:00
parent 3e516dce46
commit 786d371edc
2 changed files with 34 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -12,13 +12,9 @@ module.exports = new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, ty
// for debugging docs
// .processor(function test(){
// return {
// $runAfter: ['files-written'],
// $runAfter: ['readTypeScriptModules'],
// $runAfter: ['parsing-tags'],
// $process: function(docs){
// docs.forEach(function(doc){
// if (doc.constructorDoc){
// debugger;
// }
// })
// }
// }
// })
@ -59,8 +55,9 @@ module.exports = new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, ty
})
// Configure file writing
.config(function(writeFilesProcessor) {
writeFilesProcessor.outputFolder = 'dist/docs';
.config(function(writeFilesProcessor, versionInfo) {
// TODO(tlancina): Use nightly if version isn't specified by gulp task
writeFilesProcessor.outputFolder = 'dist/ionic-site/docs/' + versionInfo.currentVersion.raw + '/api/';
})
// Configure rendering
@ -91,24 +88,31 @@ module.exports = new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, ty
})
// Configure ids and paths
// .config(function(computeIdsProcessor, computePathsProcessor) {
// computeIdsProcessor.idTemplates.push({
// docTypes: ['guide'],
// getId: function(doc) {
// return doc.fileInfo.relativePath
// // path should be relative to `modules` folder
// .replace(/.*\/?modules\//, '')
// // path should not include `/docs/`
// .replace(/\/docs\//, '/')
// // path should not have a suffix
// .replace(/\.\w*$/, '');
// },
// getAliases: function(doc) { return [doc.id]; }
// });
//
// computePathsProcessor.pathTemplates.push({
// docTypes: ['guide'],
// pathTemplate: '/${id}',
// outputPathTemplate: 'partials/guides/${id}.html'
// });
// });
.config(function(computeIdsProcessor, computePathsProcessor, versionInfo) {
// computeIdsProcessor.idTemplates.push({
// docTypes: ['guide'],
// getId: function(doc) {
// return doc.fileInfo.relativePath
// // path should be relative to `modules` folder
// .replace(/.*\/?modules\//, '')
// // path should not include `/docs/`
// .replace(/\/docs\//, '/')
// // path should not have a suffix
// .replace(/\.\w*$/, '');
// },
// getAliases: function(doc) { return [doc.id]; }
// });
// docTypes: 'module', 'member', 'class', 'var', 'function', 'let'
computePathsProcessor.pathTemplates = [{
docTypes: ['class', 'var', 'function', 'let'],
getOutputPath: function(doc) {
return doc.fileInfo.relativePath
// strip ionic from path root
.replace(/^ionic\//, '')
// replace extension with .html
.replace(/\.\w*$/, '.html');
}
}];
});

2
scripts/docs/templates/module.template.html vendored
View File

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