3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-03 03:12:35 +02:00
Code Issues Projects Releases Packages Wiki Activity

misc: add command to run prettier on docs (#2102)

Browse source 
* misc: add command to run prettier on docs

* Fix GH issue template

* Fix tests

* Add prettier-docs command to precommit
This commit is contained in:
Yangshun Tay 2019-12-07 21:56:30 -08:00 • committed by GitHub
parent cfc313d7c7
commit 55e676cb25
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
141 changed files with 1181 additions and 968 deletions
Download patch file Download diff file Expand all files Collapse all files

41
admin/extending-remarkable.md
View file

@ -65,18 +65,35 @@ md.renderer.rules.heading_close = function(tokens, idx /*, options, env */) {
That's pretty straightforward: whenever these tokens are found, we render a `<hN>` or `</hN>` HTML tag, where N is the `hLevel` for this heading. That would result in `<h3>Hi there</h3>` being output. But what we want is something closer to this:
```html
<h3><a class="anchor" id="hi-there"></a>Hi there <a class="hash-link" href="#hi-there">#</a></h3>
<h3>
<a class="anchor" id="hi-there"></a>Hi there
<a class="hash-link" href="#hi-there">#</a>
</h3>
```
In that case, we need to override our heading rules like so:
```js
md.renderer.rules.heading_open = function(tokens, idx /*, options, env */) {
return '<h' + tokens[idx].hLevel + '>' + '<a class="anchor" id="' + toSlug(tokens[idx+1].content) + '"></a>';
return (
'<h' +
tokens[idx].hLevel +
'>' +
'<a class="anchor" id="' +
toSlug(tokens[idx + 1].content) +
'"></a>'
);
};
md.renderer.rules.heading_close = function(tokens, idx /*, options, env */) {
return ' <a class="hash-link" href="#' + toSlug(tokens[idx-1].content) + '">#</a>' + '</h' + tokens[idx].hLevel + '>\n';
return (
' <a class="hash-link" href="#' +
toSlug(tokens[idx - 1].content) +
'">#</a>' +
'</h' +
tokens[idx].hLevel +
'>\n'
);
};
```
@ -89,11 +106,25 @@ We now need to tell Remarkable to use our extension. We can wrap our rules in a
```js
function anchors(md) {
md.renderer.rules.heading_open = function(tokens, idx /*, options, env */) {
return '<h' + tokens[idx].hLevel + '>' + '<a class="anchor" id="' + toSlug(tokens[idx+1].content) + '"></a>';
return (
'<h' +
tokens[idx].hLevel +
'>' +
'<a class="anchor" id="' +
toSlug(tokens[idx + 1].content) +
'"></a>'
);
};
md.renderer.rules.heading_close = function(tokens, idx /*, options, env */) {
return ' <a class="hash-link" href="#' + toSlug(tokens[idx-1].content) + '">#</a>' + '</h' + tokens[idx].hLevel + '>\n';
return (
' <a class="hash-link" href="#' +
toSlug(tokens[idx - 1].content) +
'">#</a>' +
'</h' +
tokens[idx].hLevel +
'>\n'
);
};
}
```