diff --git a/scripts/docs/dgeni-config.js b/scripts/docs/dgeni-config.js index 845a7c8db8..7ebaf7e6f5 100644 --- a/scripts/docs/dgeni-config.js +++ b/scripts/docs/dgeni-config.js @@ -67,23 +67,16 @@ module.exports = new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, ty .config(function(templateFinder, templateEngine) { // Nunjucks and Angular conflict in their template bindings so change the Nunjucks + // Also conflict with Jekyll templateEngine.config.tags = { - variableStart: '{$', - variableEnd: '$}', + variableStart: '<$', + variableEnd: '$>', blockStart: '<@', - blockEnd: '@>' + blockEnd: '@>', + commentStart: '<#', + commentEnd: '#>' }; - //Don't conflict with the jekyll tags - // config.set('rendering.nunjucks.config.tags', { - // blockStart: '<@', - // blockEnd: '@>', - // variableStart: '<$', - // variableEnd: '$>', - // commentStart: '<#', - // commentEnd: '#>' - // }); - templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates')); // Specify how to match docs to templates. diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 9caa68f781..0c7bc6dfb0 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -1,25 +1,25 @@ <@ macro paramList(paramData) -@> <@- if paramData -@>( <@- for param in paramData -@> - {$ param | escape $}<@ if not loop.last @>, <@ endif @> + <$ param | escape $><@ if not loop.last @>, <@ endif @> <@- endfor @>) <@- endif @> <@- endmacro -@> <@ macro githubViewLink(doc) -@> - {$ doc.fileInfo.relativePath $} (line {$ doc.location.start.line+1 $}) + <$ doc.fileInfo.relativePath $> (line <$ doc.location.start.line+1 $>) <@- endmacro -@> <@ block body @> -

{$ doc.name $} {$ doc.docType $}

-

exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
-defined in {$ githubViewLink(doc) $} +

<$ doc.name $> <$ doc.docType $>

+

exported from {@link <$ doc.moduleDoc.id $> <$doc.moduleDoc.id $> }
+defined in <$ githubViewLink(doc) $>

-

{$ doc.description | marked $}

+

<$ doc.description | marked $>

<@- if doc.decorators @>

Annotations

<@- for decorator in doc.decorators @> -

@{$ decorator.name $}{$ paramList(decorator.arguments) $}

+

@<$ decorator.name $><$ paramList(decorator.arguments) $>

<@ endfor @> <@ endif -@> @@ -28,20 +28,20 @@ defined in {$ githubViewLink(doc) $} <@- if doc.constructorDoc @>
-

{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.paramData) $}

+

<$ doc.constructorDoc.name $><$ paramList(doc.constructorDoc.paramData) $>

<@ marked @> - {$ doc.constructorDoc.description $} + <$ doc.constructorDoc.description $> <@ endmarked @>
<@ endif -@> <@- for member in doc.members @><@ if not member.private @>
-

- {$ member.name $}<@ if member.optional @>?<@ endif @>{$ paramList(member.params) $} +

+ <$ member.name $><@ if member.optional @>?<@ endif @><$ paramList(member.params) $>

<@ marked @> - {$ member.description $} + <$ member.description $> <@ endmarked @>