Skip to content

Commit 119ede3

Browse files
authored
docs: fix syntax highlighting (#137)
1 parent d6b8086 commit 119ede3

File tree

9 files changed

+33
-53
lines changed

9 files changed

+33
-53
lines changed

docs/integrations/authentik/authentik.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,7 @@ return {
7272
Since you have decided to go the advanced way, you will have to use [**Message Templates**](../configuration/message-templates), here is an example:
7373

7474
```yaml
75-
settings:
76-
message:
77-
template: |
78-
**Your Verification Code**
79-
80-
Use the verification code below to complete your sign-in:
81-
82-
{{ @token }}
83-
84-
This code expires in 5 minutes⏱️.
85-
If you didn’t request it, you can ignore this message.
75+
{{{ #://./message-template.yaml }}}
8676
```
8777

8878
### 4. Enable SMS-Verification
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
settings:
22
message:
3+
# prettier-ignore
34
template: |
45
**Your Verification Code**
56
67
Use the verification code below to complete your sign-in:
78
89
{{ @token }}
9-
10+
1011
This code expires in 5 minutes⏱️.
1112
If you didn’t request it, you can ignore this message.

docs/integrations/gitea/message-template.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
settings:
22
message:
3+
# prettier-ignore
34
template: |
45
{{- /* === ISSUE === */ - }}
56
{{- if and @issue (ne @issue nil) (not @is_pull) -}}
67
📝 **#{{@issue.number}} {{@issue.title}}**
78
{{ if eq @issue.state "open" -}}🟢{{- else if eq @issue.state "closed" -}}🔴{{- else -}}{{@issue.state}}{{- end }} | 👤 {{@sender.full_name}}
89
🔗 {{@issue.html_url}}
910
{{- end -}}
10-
11+
1112
{{- /* === PULL REQUEST === */ - }}
1213
{{- if and @pull_request (ne @pull_request nil) -}}
1314
🚀 **#{{@pull_request.number}} {{@pull_request.title}}**
1415
{{ if eq @pull_request.state "open" -}}🟢{{- else if eq @pull_request.state "closed" -}}🔴{{- else if eq @pull_request.state "merged" -}}🟣{{- else -}}{{@pull_request.state}}{{- end }} | 👤 {{@sender.full_name}}
1516
🔗 {{@pull_request.html_url}}
1617
{{- end -}}
17-
18+
1819
{{- /* === COMMIT === */ - }}
1920
{{- if and @commits (gt (len @commits) 0) }}
2021
📥️ **Push** → *{{@ref}}*
@@ -32,6 +33,6 @@ settings:
3233
{{- end }}
3334
🔗 {{.url}}
3435
{{- end }}
35-
36+
3637
🔎 Compare: {{@compare_url}}
3738
{{- end -}}

docusaurus.config.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,11 @@ const config = {
6262
beforeDefaultRemarkPlugins: [
6363
require("remark-github-admonitions-to-directives"),
6464
],
65-
remarkPlugins: [require("remark-gfm"), require("remark-directive")],
65+
remarkPlugins: [
66+
require("remark-gfm"),
67+
require("remark-directive"),
68+
require("./prettier-ignore"),
69+
],
6670
},
6771
theme: {
6872
customCss: ["./src/css/custom.css"],
@@ -144,7 +148,6 @@ const config = {
144148
additionalLanguages: [
145149
"bash",
146150
"apacheconf",
147-
"custom-yaml-scalar",
148151
"custom-go-template",
149152
"custom-yaml-go-template",
150153
"custom-yaml-empty-key",

package-lock.json

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
"react-dom": "^19.0.0",
2525
"remark-directive": "^4.0.0",
2626
"remark-gfm": "^4.0.1",
27-
"remark-github-admonitions-to-directives": "^2.1.0"
27+
"remark-github-admonitions-to-directives": "^2.1.0",
28+
"unist-util-visit": "^5.0.0"
2829
},
2930
"devDependencies": {
3031
"@docusaurus/module-type-aliases": "3.9.2",

prettier-ignore.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
module.exports = () => {
2+
return (tree) => {
3+
const visit = require("unist-util-visit").visit
4+
5+
visit(tree, "code", (node) => {
6+
if (node.value) {
7+
// Remove any line that contains "# prettier-ignore"
8+
node.value = node.value
9+
.split("\n")
10+
.filter((line) => !line.includes("# prettier-ignore"))
11+
.join("\n")
12+
}
13+
})
14+
}
15+
}

src/theme/prism/custom/prism-go-template.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const lang = "go-template"
99
alias: "comment",
1010
inside: {
1111
delimiter: /^\{\{\/\*|\*\/\}\}/,
12-
content: /[\s\S]+/, // the inner comment content
12+
content: /[\s\S]+/,
1313
},
1414
},
1515

@@ -20,7 +20,7 @@ const lang = "go-template"
2020
alias: "variable",
2121
inside: {
2222
delimiter: /^\{\{|\}\}$/,
23-
expression: /[\s\S]+/, // the inner expression
23+
expression: /[\s\S]+/,
2424
},
2525
},
2626
}

src/theme/prism/custom/prism-yaml-scalar.js

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)