honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

build(docs-infra): mark code blocks to disable auto-linking (#26675) 

You can now mark `<code>` blocks with a `no-auto-link` css class
to tell the code auto-linker to ignore this code block.

PR Close #26675
This commit is contained in:
Pete Bacon Darwin 2018-10-23 11:02:29 +01:00 committed by Matias Niemelä
parent 56f44be0aa
commit 9ff8155cd9
2 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
aio/tools/transforms/angular-base-package/post-processors/auto-link-code.js vendored
View File

@ -30,7 +30,9 @@ module.exports = function autoLinkCode(getDocFromAlias) {
return (ast) => { return (ast) => {
visit(ast, 'element', (node, ancestors) => { visit(ast, 'element', (node, ancestors) => {
// Only interested in code elements that are not inside links // Only interested in code elements that are not inside links
if (autoLinkCodeImpl.codeElements.some(elementType => is(node, elementType)) && if (autoLinkCodeImpl.codeElements.some(elementType =>
is(node, elementType)) &&
(!node.properties.className || node.properties.className.indexOf('no-auto-link') === -1) &&
ancestors.every(ancestor => !is(ancestor, 'a'))) { ancestors.every(ancestor => !is(ancestor, 'a'))) {
visit(node, 'text', (node, ancestors) => { visit(node, 'text', (node, ancestors) => {
// Only interested in text nodes that are not inside links // Only interested in text nodes that are not inside links

7
aio/tools/transforms/angular-base-package/post-processors/auto-link-code.spec.js
View File

@ -109,4 +109,11 @@ describe('autoLinkCode post-processor', () => {
processor.$process([doc]); processor.$process([doc]);
expect(doc.renderedContent).toEqual('<code-example><a href="a/b/myclass" class="code-anchor">MyClass</a></code-example>'); expect(doc.renderedContent).toEqual('<code-example><a href="a/b/myclass" class="code-anchor">MyClass</a></code-example>');
}); });
it('should ignore code blocks that are marked with a `no-auto-link` class', () => {
aliasMap.addDoc({ docType: 'class', id: 'MyClass', aliases: ['MyClass'], path: 'a/b/myclass' });
const doc = { docType: 'test-doc', renderedContent: '<code class="no-auto-link">MyClass</code>' };
processor.$process([doc]);
expect(doc.renderedContent).toEqual('<code class="no-auto-link">MyClass</code>');
});
}); });