29 | This is a minimalist demonstration of the 30 | markdown-it-docutils 33 | plugin. 34 |
35 |
36 | Simply write in the text box below, then click away, and the text will be
37 | rendered.
Note the color scheme is adaptive to browser settings, see
38 | prefers-color-scheme
42 | for details.
43 |
${token.content}`
25 | }
26 |
27 | // TODO: when another renderer comes up, refactor into something a bit more scalable
28 | inlineMathRenderer(md, options)
29 |
30 | // TODO role_error renderer
31 | }
32 |
33 | function roleRule(state: StateInline, silent: boolean): boolean {
34 | // Check if the role is escaped
35 | if (state.src.charCodeAt(state.pos - 1) === 0x5c) {
36 | /* \ */
37 | // TODO: this could be improved in the case of edge case '\\{', also multi-line
38 | return false
39 | }
40 | const match = ROLE_PATTERN.exec(state.src.slice(state.pos))
41 | if (match == null) return false
42 | const [str, name, , content] = match
43 | // eslint-disable-next-line no-param-reassign
44 | state.pos += str.length
45 |
46 | if (!silent) {
47 | const token = state.push("role", "", 0)
48 | token.meta = { name }
49 | token.content = content
50 | }
51 | return true
52 | }
53 |
54 | // MyST role syntax format e.g. {role}`text`
55 | // TODO: support role with no value e.g. {role}``
56 | let _x: RegExp
57 | try {
58 | _x = new RegExp("^\\{([a-zA-Z_\\-+:]{1,36})\\}(`+)(?!`)(.+?)(? boolean {
70 | function func(state: StateCore): boolean {
71 | for (const token of state.tokens) {
72 | if (token.type === "inline" && token.children) {
73 | const childTokens = []
74 | for (const child of token.children) {
75 | // TODO role name translations
76 | if (child.type === "role" && child.meta?.name in roles) {
77 | try {
78 | const role = new roles[child.meta.name](state)
79 | const roleOpen = new state.Token("parsed_role_open", "", 1)
80 | roleOpen.content = child.content
81 | roleOpen.hidden = true
82 | roleOpen.meta = { name: child.meta.name }
83 | roleOpen.block = false
84 | const newTokens = [roleOpen]
85 | newTokens.push(
86 | ...role.run({
87 | parentMap: token.map,
88 | content: child.content
89 | })
90 | )
91 | const roleClose = new state.Token("parsed_role_close", "", -1)
92 | roleClose.block = false
93 | roleClose.hidden = true
94 | newTokens.push(roleClose)
95 | childTokens.push(...newTokens)
96 | } catch (err) {
97 | const errorToken = new state.Token("role_error", "", 0)
98 | errorToken.content = child.content
99 | errorToken.info = child.info
100 | errorToken.meta = child.meta
101 | errorToken.map = child.map
102 | errorToken.meta.error_message = (err as Error).message
103 | errorToken.meta.error_name = (err as Error).name
104 | childTokens.push(errorToken)
105 | }
106 | } else {
107 | childTokens.push(child)
108 | }
109 | }
110 | token.children = childTokens
111 | }
112 | }
113 | return true
114 | }
115 | return func
116 | }
117 |
--------------------------------------------------------------------------------
/src/roles/references.ts:
--------------------------------------------------------------------------------
1 | import type Token from "markdown-it/lib/token"
2 | import { resolveRefLater, TargetKind } from "../state/utils"
3 | import { IRoleData, Role } from "./main"
4 |
5 | const REF_PATTERN = /^(.+?)<([^<>]+)>$/ // e.g. 'Labeled Reference '
6 |
7 | export class Eq extends Role {
8 | run(data: IRoleData): Token[] {
9 | const open = new this.state.Token("ref_open", "a", 1)
10 | const content = new this.state.Token("text", "", 0)
11 | const close = new this.state.Token("ref_close", "a", -1)
12 | resolveRefLater(
13 | this.state,
14 | { open, content, close },
15 | { kind: "eq", label: data.content },
16 | {
17 | kind: TargetKind.equation,
18 | contentFromTarget: target => {
19 | return `(${target.number})`
20 | }
21 | }
22 | )
23 | return [open, content, close]
24 | }
25 | }
26 |
27 | export class NumRef extends Role {
28 | run(data: IRoleData): Token[] {
29 | const match = REF_PATTERN.exec(data.content)
30 | const [, modified, ref] = match ?? []
31 | const withoutLabel = modified?.trim()
32 | const open = new this.state.Token("ref_open", "a", 1)
33 | const content = new this.state.Token("text", "", 0)
34 | const close = new this.state.Token("ref_close", "a", -1)
35 | resolveRefLater(
36 | this.state,
37 | { open, content, close },
38 | { kind: "numref", label: ref || data.content, value: withoutLabel },
39 | {
40 | contentFromTarget: target => {
41 | if (!match) return target.title.trim()
42 | return withoutLabel
43 | .replace(/%s/g, String(target.number))
44 | .replace(/\{number\}/g, String(target.number))
45 | }
46 | }
47 | )
48 | return [open, content, close]
49 | }
50 | }
51 |
52 | export class Ref extends Role {
53 | run(data: IRoleData): Token[] {
54 | const match = REF_PATTERN.exec(data.content)
55 | const [, modified, ref] = match ?? []
56 | const withoutLabel = modified?.trim()
57 | const open = new this.state.Token("ref_open", "a", 1)
58 | const content = new this.state.Token("text", "", 0)
59 | const close = new this.state.Token("ref_close", "a", -1)
60 | resolveRefLater(
61 | this.state,
62 | { open, content, close },
63 | { kind: "ref", label: ref || data.content, value: withoutLabel },
64 | {
65 | contentFromTarget: target => {
66 | return withoutLabel || target.title
67 | }
68 | }
69 | )
70 | return [open, content, close]
71 | }
72 | }
73 |
74 | export const references = {
75 | eq: Eq,
76 | ref: Ref,
77 | numref: NumRef
78 | }
79 |
--------------------------------------------------------------------------------
/src/roles/types.ts:
--------------------------------------------------------------------------------
1 | import type { Role } from "./main"
2 |
3 | export interface IMathRoleOptions {
4 | renderer?: (content: string, opts: { displayMode: boolean }) => string
5 | }
6 |
7 | /** Allowed options for directive plugin */
8 | export interface IOptions {
9 | /** Parse roles of the form `` {name}`content` `` */
10 | parseRoles?: boolean
11 | /** Core rule to run roles after (default: inline) */
12 | rolesAfter?: string
13 | /** Mapping of names to roles */
14 | roles?: Record
28 | The Jupyter Book Logo!
30 |A caption
47 |A caption
64 |
77 | The Jupyter Book Logo!
79 |a
20 | a
30 | a
40 | a
50 | a
60 | a
72 | | Row 1, Column 1 | Row 1, Column 2 | Row 1, Column 3 |
| Row 2, Column 1 | Row 2, Column 2 | Row 2, Column 3 |
| Row 3, Column 1 | Row 3, Column 2 | Row 3, Column 3 |
| Head 1, Column 1 | Head 1, Column 2 | Head 1, Column 3 |
|---|---|---|
| Row 1, Column 1 | Row 1, Column 2 | Row 1, Column 3 |
| Row 2, Column 1 | Row 2, Column 2 | Row 2, Column 3 |
H2O
6 | . 7 | 8 | Superscript: 9 | . 10 | 4{sup}`th` of July 11 | . 12 |4th of July
13 | . 14 | 15 | Abbr with title: 16 | . 17 | {abbr}`CSS (Cascading Style Sheets)` 18 | . 19 |CSS
20 | . 21 | 22 | Abbr without title: 23 | . 24 | {abbr}`CSS` 25 | . 26 |CSS
27 | . 28 | 29 | Abbr with poor brackets: 30 | . 31 | {abbr}`CSS (Cascading) Style( Sheets)` 32 | . 33 |CSS (Cascading) Style
34 | . 35 | -------------------------------------------------------------------------------- /tests/fixtures/roles.math.md: -------------------------------------------------------------------------------- 1 | single character inline equation. (valid=True) 2 | . 3 | {math}`a` 4 | . 5 |a
6 | . 7 | 8 | inline equation with single greek character (valid=True) 9 | . 10 | {math}`\\varphi` 11 | . 12 |\\varphi
13 | . 14 | 15 | simple equation starting and ending with numbers. (valid=True) 16 | . 17 | {math}`1+1=2` 18 | . 19 |1+1=2
20 | . 21 | 22 | simple equation including special html character. (valid=True) 23 | . 24 | {math}`1+1<3` 25 | . 26 |1+1<3
27 | . 28 | -------------------------------------------------------------------------------- /tests/fixtures/roles.md: -------------------------------------------------------------------------------- 1 | role-unhandled 2 | . 3 | A role {name}`content` in paragraph 4 | . 5 |A role namecontent in paragraph
content
Check out (1)!
14 | . 15 | -------------------------------------------------------------------------------- /tests/fixtures/roles.references.numref.md: -------------------------------------------------------------------------------- 1 | Testing named figures and numbered references 2 | . 3 | ```{figure} https://via.placeholder.com/150 4 | :name: test3 5 | 6 | Fig 1 7 | ``` 8 | 9 | ```{figure} https://via.placeholder.com/150 10 | :name: test4 11 | 12 | Fig 2 13 | ``` 14 | The reference to {ref}`test3` and {ref}`test4`. 15 | {numref}`test3` 16 | {numref}`test4` 17 | {numref}`Hi 1Fig 1
31 |Fig 2
38 |The reference to Fig 1 and Fig 2.
42 | Fig 1
43 | Fig 2
44 | Hi 1
45 | Hi 2
46 | This is 1: 1
47 | This is 2: 2
48 | This is 2: 2
49 | test5
50 | Not there "test5"
51 | Not there "test5"
52 | Not there {number}