Skip to content

build(aio): convert triple backtick blocks to code-example tags #16433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mhevery merged 2 commits into from
Apr 30, 2017
Merged

build(aio): convert triple backtick blocks to code-example tags #16433

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf52199
build(aio): remove unused `{@exampleTabs}` inline tag
petebacondarwin Apr 29, 2017
3cff741
build(aio): convert triple backtick blocks to `code-example` tags
petebacondarwin Apr 29, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
build(aio): convert triple backtick blocks to code-example tags 
Closes #16246
  • Loading branch information
@petebacondarwin
petebacondarwin committed Apr 29, 2017
commit 3cff74117944f0885f1953b3f1f23026a06cd840
11 changes: 11 additions & 0 deletions aio/content/marketing/test.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,17 @@ <h2>&lt;code-example&gt;</h2>
&lt;/hero-details&gt;
</code-example>

## Backticked code blocks

```html
<hero-details>
<h2>Mister Fantastic</h2>
<hero-team>
<h3>Losing Team</h3>
</hero-team>
</hero-details>
```

<h2>&lt;live-example&gt;</h2>

<p>Plain live-example</p>
Expand Down
14 changes: 14 additions & 0 deletions aio/tools/transforms/remark-package/services/handlers/code.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/**
* Render markdown code blocks as `<code-example>` tags
*/
module.exports = function code(h, node) {
var value = node.value ? ('\n' + node.value + '\n') : '';
var lang = node.lang && node.lang.match(/^[^ \t]+(?=[ \t]|$)/);
var props = {};

if (lang) {
props.language = lang;
}

return h(node, 'code-example', props, [{ type: 'text', value }]);
};
4 changes: 3 additions & 1 deletion aio/tools/transforms/remark-package/services/renderMarkdown.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
const remark = require('remark');
const html = require('remark-html');
const code = require('./handlers/code');

/**
* @dgService renderMarkdown
* @description
* Render the markdown in the given string as HTML.
*/
module.exports = function renderMarkdown() {
const handlers = { code };
const renderer = remark()
.use(inlineTagDefs)
.use(noIndentedCodeBlocks)
Expand All @@ -15,7 +17,7 @@ module.exports = function renderMarkdown() {
// .use(() => tree => {
// console.log(require('util').inspect(tree, { colors: true, depth: 4 }));
// })
.use(html);
.use(html, { handlers });

return function renderMarkdownImpl(content) {
return renderer.processSync(content).toString();
Expand Down
17 changes: 17 additions & 0 deletions aio/tools/transforms/remark-package/services/renderMarkdown.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,21 @@ describe('remark: renderMarkdown service', () => {
const output = renderMarkdown(content);
expect(output).toEqual('<p>some text</p>\n<p> indented text</p>\n<p>other text</p>\n');
});

it('should format triple backtick code blocks as `code-example` tags', () => {
const content =
'```ts\n' +
' class MyClass {\n' +
' method1() { ... }\n' +
' }\n' +
'```';
const output = renderMarkdown(content);
expect(output).toEqual(
'<code-example language="ts">\n' +
' class MyClass {\n' +
' method1() { ... }\n' +
' }\n' +
'</code-example>\n'
);
});
});