docrev 0.9.17 → 0.9.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/anchor-match.d.ts +1 -1
- package/dist/lib/anchor-match.d.ts.map +1 -1
- package/dist/lib/anchor-match.js +17 -47
- package/dist/lib/anchor-match.js.map +1 -1
- package/dist/lib/build.d.ts +111 -1
- package/dist/lib/build.d.ts.map +1 -1
- package/dist/lib/build.js +351 -21
- package/dist/lib/build.js.map +1 -1
- package/dist/lib/commands/build.d.ts.map +1 -1
- package/dist/lib/commands/build.js +25 -10
- package/dist/lib/commands/build.js.map +1 -1
- package/dist/lib/schema.d.ts.map +1 -1
- package/dist/lib/schema.js +37 -0
- package/dist/lib/schema.js.map +1 -1
- package/docs-src/build.py +113 -113
- package/docs-src/extra.css +208 -208
- package/docs-src/md-to-html.lua +6 -6
- package/docs-src/template.html +116 -116
- package/issues.md +180 -0
- package/lib/anchor-match.ts +17 -49
- package/lib/build.ts +410 -22
- package/lib/commands/build.ts +32 -10
- package/lib/schema.ts +37 -0
- package/mkdocs.yml +64 -64
- package/package.json +1 -1
- package/site/assets/extra.css +208 -0
- package/site/commands.html +926 -0
- package/site/configuration.html +469 -0
- package/site/index.html +288 -0
- package/site/troubleshooting.html +461 -0
- package/site/workflow.html +518 -0
- package/skill/REFERENCE.md +66 -0
- package/skill/SKILL.md +25 -4
- package/.claude/settings.local.json +0 -9
package/lib/schema.ts
CHANGED
|
@@ -91,6 +91,23 @@ export const revYamlSchema: Schema = {
|
|
|
91
91
|
type: 'string',
|
|
92
92
|
description: 'Journal profile name for formatting defaults and validation',
|
|
93
93
|
},
|
|
94
|
+
'pandoc-args': {
|
|
95
|
+
type: 'array',
|
|
96
|
+
description: 'Extra pandoc args applied to every format build (e.g. --lua-filter=...). Format-specific lists are appended after these; --pandoc-arg CLI values are appended last.',
|
|
97
|
+
items: { type: 'string' },
|
|
98
|
+
},
|
|
99
|
+
output: {
|
|
100
|
+
type: 'object',
|
|
101
|
+
description: 'Per-format output filenames. Keys are format names (pdf, docx, tex, beamer, pptx); values are paths. Relative paths resolve under outputDir; absolute paths are honored as-is. Extension auto-added if missing. CLI `-o` overrides this map.',
|
|
102
|
+
properties: {
|
|
103
|
+
pdf: { type: 'string' },
|
|
104
|
+
docx: { type: 'string' },
|
|
105
|
+
tex: { type: 'string' },
|
|
106
|
+
beamer: { type: 'string' },
|
|
107
|
+
pptx: { type: 'string' },
|
|
108
|
+
},
|
|
109
|
+
additionalProperties: false,
|
|
110
|
+
},
|
|
94
111
|
sections: {
|
|
95
112
|
type: 'array',
|
|
96
113
|
description: 'Ordered list of section files to include',
|
|
@@ -160,6 +177,11 @@ export const revYamlSchema: Schema = {
|
|
|
160
177
|
toc: { type: 'boolean', default: false },
|
|
161
178
|
header: { type: 'string' },
|
|
162
179
|
footer: { type: 'string' },
|
|
180
|
+
'pandoc-args': {
|
|
181
|
+
type: 'array',
|
|
182
|
+
description: 'Extra pandoc args for PDF builds. Appended after the top-level pandoc-args list.',
|
|
183
|
+
items: { type: 'string' },
|
|
184
|
+
},
|
|
163
185
|
},
|
|
164
186
|
additionalProperties: true,
|
|
165
187
|
},
|
|
@@ -170,6 +192,16 @@ export const revYamlSchema: Schema = {
|
|
|
170
192
|
reference: { type: 'string', description: 'Reference document for styling' },
|
|
171
193
|
keepComments: { type: 'boolean', default: true },
|
|
172
194
|
toc: { type: 'boolean', default: false },
|
|
195
|
+
translateRawFigures: {
|
|
196
|
+
type: 'boolean',
|
|
197
|
+
default: true,
|
|
198
|
+
description: 'Auto-translate the common \\begin{figure}...\\end{figure} shape to portable ![](){#fig: ...} markdown so figures render in docx. Pandoc strips raw LaTeX in docx output silently otherwise.',
|
|
199
|
+
},
|
|
200
|
+
'pandoc-args': {
|
|
201
|
+
type: 'array',
|
|
202
|
+
description: 'Extra pandoc args for DOCX builds. Appended after the top-level pandoc-args list.',
|
|
203
|
+
items: { type: 'string' },
|
|
204
|
+
},
|
|
173
205
|
},
|
|
174
206
|
additionalProperties: true,
|
|
175
207
|
},
|
|
@@ -178,6 +210,11 @@ export const revYamlSchema: Schema = {
|
|
|
178
210
|
description: 'LaTeX output settings',
|
|
179
211
|
properties: {
|
|
180
212
|
standalone: { type: 'boolean', default: true },
|
|
213
|
+
'pandoc-args': {
|
|
214
|
+
type: 'array',
|
|
215
|
+
description: 'Extra pandoc args for TeX builds. Appended after the top-level pandoc-args list.',
|
|
216
|
+
items: { type: 'string' },
|
|
217
|
+
},
|
|
181
218
|
},
|
|
182
219
|
additionalProperties: true,
|
|
183
220
|
},
|
package/mkdocs.yml
CHANGED
|
@@ -1,64 +1,64 @@
|
|
|
1
|
-
site_name: docrev
|
|
2
|
-
site_url: https://gillescolling.com/docrev
|
|
3
|
-
site_description: CLI for writing documents in Markdown while collaborating with Word users.
|
|
4
|
-
site_author: Gilles Colling
|
|
5
|
-
repo_url: https://github.com/gcol33/docrev
|
|
6
|
-
repo_name: gcol33/docrev
|
|
7
|
-
|
|
8
|
-
theme:
|
|
9
|
-
name: material
|
|
10
|
-
palette:
|
|
11
|
-
- scheme: default
|
|
12
|
-
primary: custom
|
|
13
|
-
accent: custom
|
|
14
|
-
toggle:
|
|
15
|
-
icon: material/brightness-7
|
|
16
|
-
name: Switch to dark mode
|
|
17
|
-
- scheme: slate
|
|
18
|
-
primary: custom
|
|
19
|
-
accent: custom
|
|
20
|
-
toggle:
|
|
21
|
-
icon: material/brightness-4
|
|
22
|
-
name: Switch to light mode
|
|
23
|
-
font:
|
|
24
|
-
text: Roboto
|
|
25
|
-
code: Roboto Mono
|
|
26
|
-
features:
|
|
27
|
-
- navigation.tabs
|
|
28
|
-
- navigation.top
|
|
29
|
-
- navigation.instant
|
|
30
|
-
- search.highlight
|
|
31
|
-
- content.code.copy
|
|
32
|
-
icon:
|
|
33
|
-
repo: fontawesome/brands/github
|
|
34
|
-
|
|
35
|
-
nav:
|
|
36
|
-
- Home: index.md
|
|
37
|
-
- Get Started: workflow.md
|
|
38
|
-
- Commands: commands.md
|
|
39
|
-
- Configuration: configuration.md
|
|
40
|
-
- Troubleshooting: troubleshooting.md
|
|
41
|
-
|
|
42
|
-
markdown_extensions:
|
|
43
|
-
- pymdownx.highlight:
|
|
44
|
-
anchor_linenums: true
|
|
45
|
-
- pymdownx.superfences
|
|
46
|
-
- pymdownx.inlinehilite
|
|
47
|
-
- pymdownx.tabbed:
|
|
48
|
-
alternate_style: true
|
|
49
|
-
- admonition
|
|
50
|
-
- pymdownx.details
|
|
51
|
-
- attr_list
|
|
52
|
-
- md_in_html
|
|
53
|
-
- toc:
|
|
54
|
-
permalink: true
|
|
55
|
-
|
|
56
|
-
extra_css:
|
|
57
|
-
- stylesheets/extra.css
|
|
58
|
-
|
|
59
|
-
extra:
|
|
60
|
-
social:
|
|
61
|
-
- icon: fontawesome/brands/github
|
|
62
|
-
link: https://github.com/gcol33/docrev
|
|
63
|
-
- icon: fontawesome/brands/npm
|
|
64
|
-
link: https://www.npmjs.com/package/docrev
|
|
1
|
+
site_name: docrev
|
|
2
|
+
site_url: https://gillescolling.com/docrev
|
|
3
|
+
site_description: CLI for writing documents in Markdown while collaborating with Word users.
|
|
4
|
+
site_author: Gilles Colling
|
|
5
|
+
repo_url: https://github.com/gcol33/docrev
|
|
6
|
+
repo_name: gcol33/docrev
|
|
7
|
+
|
|
8
|
+
theme:
|
|
9
|
+
name: material
|
|
10
|
+
palette:
|
|
11
|
+
- scheme: default
|
|
12
|
+
primary: custom
|
|
13
|
+
accent: custom
|
|
14
|
+
toggle:
|
|
15
|
+
icon: material/brightness-7
|
|
16
|
+
name: Switch to dark mode
|
|
17
|
+
- scheme: slate
|
|
18
|
+
primary: custom
|
|
19
|
+
accent: custom
|
|
20
|
+
toggle:
|
|
21
|
+
icon: material/brightness-4
|
|
22
|
+
name: Switch to light mode
|
|
23
|
+
font:
|
|
24
|
+
text: Roboto
|
|
25
|
+
code: Roboto Mono
|
|
26
|
+
features:
|
|
27
|
+
- navigation.tabs
|
|
28
|
+
- navigation.top
|
|
29
|
+
- navigation.instant
|
|
30
|
+
- search.highlight
|
|
31
|
+
- content.code.copy
|
|
32
|
+
icon:
|
|
33
|
+
repo: fontawesome/brands/github
|
|
34
|
+
|
|
35
|
+
nav:
|
|
36
|
+
- Home: index.md
|
|
37
|
+
- Get Started: workflow.md
|
|
38
|
+
- Commands: commands.md
|
|
39
|
+
- Configuration: configuration.md
|
|
40
|
+
- Troubleshooting: troubleshooting.md
|
|
41
|
+
|
|
42
|
+
markdown_extensions:
|
|
43
|
+
- pymdownx.highlight:
|
|
44
|
+
anchor_linenums: true
|
|
45
|
+
- pymdownx.superfences
|
|
46
|
+
- pymdownx.inlinehilite
|
|
47
|
+
- pymdownx.tabbed:
|
|
48
|
+
alternate_style: true
|
|
49
|
+
- admonition
|
|
50
|
+
- pymdownx.details
|
|
51
|
+
- attr_list
|
|
52
|
+
- md_in_html
|
|
53
|
+
- toc:
|
|
54
|
+
permalink: true
|
|
55
|
+
|
|
56
|
+
extra_css:
|
|
57
|
+
- stylesheets/extra.css
|
|
58
|
+
|
|
59
|
+
extra:
|
|
60
|
+
social:
|
|
61
|
+
- icon: fontawesome/brands/github
|
|
62
|
+
link: https://github.com/gcol33/docrev
|
|
63
|
+
- icon: fontawesome/brands/npm
|
|
64
|
+
link: https://www.npmjs.com/package/docrev
|
package/package.json
CHANGED
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
/* ── Base ──────────────────────────────────────────────── */
|
|
2
|
+
html, body {
|
|
3
|
+
height: 100%;
|
|
4
|
+
}
|
|
5
|
+
|
|
6
|
+
body {
|
|
7
|
+
background-color: #F5F6F8;
|
|
8
|
+
color: #3E3F3A;
|
|
9
|
+
display: flex;
|
|
10
|
+
flex-direction: column;
|
|
11
|
+
min-height: 100vh;
|
|
12
|
+
padding-top: 4rem;
|
|
13
|
+
font-family: "Roboto", -apple-system, BlinkMacSystemFont, "Segoe UI", system-ui, sans-serif;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
.container { flex: 1; }
|
|
17
|
+
footer { margin-top: auto; }
|
|
18
|
+
|
|
19
|
+
/* ── Navbar (pkgdown-style subtle tint, not bg-primary) ── */
|
|
20
|
+
.navbar {
|
|
21
|
+
background: color-mix(in oklab, color-mix(in oklab, var(--bs-body-bg) 95%, var(--bs-primary)) 95%, var(--bs-body-color));
|
|
22
|
+
border-bottom: 1px solid #DFD7CA;
|
|
23
|
+
line-height: initial;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
.navbar .nav-link.active {
|
|
27
|
+
font-weight: 600;
|
|
28
|
+
color: var(--bs-primary) !important;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/* ── Links ─────────────────────────────────────────────── */
|
|
32
|
+
a { color: #325D88; }
|
|
33
|
+
a:hover { color: #1E3D5C; }
|
|
34
|
+
|
|
35
|
+
/* ── Headings ──────────────────────────────────────────── */
|
|
36
|
+
h1 { font-size: 2rem; font-weight: 600; margin-bottom: 1rem; }
|
|
37
|
+
h2 {
|
|
38
|
+
font-size: 1.4rem; font-weight: 600;
|
|
39
|
+
margin-top: 2rem; margin-bottom: .65rem;
|
|
40
|
+
padding-bottom: .3rem;
|
|
41
|
+
border-bottom: 1px solid #DFD7CA;
|
|
42
|
+
}
|
|
43
|
+
h3 { font-size: 1.1rem; font-weight: 600; margin-top: 1.5rem; }
|
|
44
|
+
h4 { font-size: 1rem; font-weight: 600; margin-top: 1.2rem; }
|
|
45
|
+
|
|
46
|
+
/* ── Code ──────────────────────────────────────────────── */
|
|
47
|
+
pre, div.sourceCode {
|
|
48
|
+
background-color: #EEEEED;
|
|
49
|
+
border: 1px solid #DFD7CA;
|
|
50
|
+
border-radius: .375rem;
|
|
51
|
+
padding: .9rem 1.1rem;
|
|
52
|
+
font-size: .85rem;
|
|
53
|
+
overflow-x: auto;
|
|
54
|
+
margin: 1em 0;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
code {
|
|
58
|
+
background-color: #EEEEED;
|
|
59
|
+
color: #3E3F3A;
|
|
60
|
+
border-radius: .25rem;
|
|
61
|
+
padding: .1em .35em;
|
|
62
|
+
font-size: .875em;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
pre code, div.sourceCode code {
|
|
66
|
+
background: none;
|
|
67
|
+
padding: 0;
|
|
68
|
+
border-radius: 0;
|
|
69
|
+
font-size: inherit;
|
|
70
|
+
color: inherit;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
div.sourceCode { padding: 0; }
|
|
74
|
+
div.sourceCode pre { border: none; margin: 0; }
|
|
75
|
+
|
|
76
|
+
/* ── Tables ────────────────────────────────────────────── */
|
|
77
|
+
table {
|
|
78
|
+
width: 100%;
|
|
79
|
+
border-collapse: collapse;
|
|
80
|
+
margin: 1em 0;
|
|
81
|
+
font-size: .9rem;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
thead th {
|
|
85
|
+
background-color: #DFD7CA;
|
|
86
|
+
color: #3E3F3A;
|
|
87
|
+
font-weight: 600;
|
|
88
|
+
padding: .5rem .75rem;
|
|
89
|
+
border-bottom: 2px solid #c8c0b4;
|
|
90
|
+
text-align: left;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
td, th { padding: .4rem .75rem; border-bottom: 1px solid #e8e2d8; }
|
|
94
|
+
tbody tr:hover { background-color: rgba(223,215,202,.2); }
|
|
95
|
+
|
|
96
|
+
/* ── TOC sidebar ───────────────────────────────────────── */
|
|
97
|
+
aside#toc, aside .toc, aside nav.toc { font-size: .875rem; }
|
|
98
|
+
|
|
99
|
+
aside h2.h6 {
|
|
100
|
+
text-transform: uppercase;
|
|
101
|
+
font-size: .68rem;
|
|
102
|
+
letter-spacing: .07em;
|
|
103
|
+
color: #6c757d;
|
|
104
|
+
font-weight: 600;
|
|
105
|
+
margin-bottom: .5rem;
|
|
106
|
+
border: none;
|
|
107
|
+
padding: 0;
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
aside .toc, aside #TOC {
|
|
111
|
+
position: sticky;
|
|
112
|
+
top: 5rem;
|
|
113
|
+
max-height: calc(100vh - 6rem);
|
|
114
|
+
overflow-y: auto;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
aside ul {
|
|
118
|
+
list-style: none;
|
|
119
|
+
padding-left: .9rem;
|
|
120
|
+
margin: 0;
|
|
121
|
+
}
|
|
122
|
+
aside > nav > .toc > ul,
|
|
123
|
+
aside .toc > ul { padding-left: 0; }
|
|
124
|
+
|
|
125
|
+
aside li { margin: .1rem 0; }
|
|
126
|
+
|
|
127
|
+
aside a {
|
|
128
|
+
color: #6c757d;
|
|
129
|
+
text-decoration: none;
|
|
130
|
+
display: block;
|
|
131
|
+
line-height: 1.55;
|
|
132
|
+
}
|
|
133
|
+
aside a:hover { color: #325D88; }
|
|
134
|
+
|
|
135
|
+
/* ── Home page cards ───────────────────────────────────── */
|
|
136
|
+
.doc-card {
|
|
137
|
+
border: 1px solid #DFD7CA;
|
|
138
|
+
border-radius: .375rem;
|
|
139
|
+
padding: 1.1rem 1.25rem;
|
|
140
|
+
height: 100%;
|
|
141
|
+
background: #fff;
|
|
142
|
+
transition: border-color .15s, box-shadow .15s;
|
|
143
|
+
}
|
|
144
|
+
.doc-card:hover {
|
|
145
|
+
border-color: #325D88;
|
|
146
|
+
box-shadow: 0 2px 8px rgba(50,93,136,.1);
|
|
147
|
+
}
|
|
148
|
+
.doc-card h5 { font-size: 1rem; font-weight: 600; margin-bottom: .4rem; }
|
|
149
|
+
.doc-card p { font-size: .875rem; color: #6c757d; margin-bottom: .6rem; }
|
|
150
|
+
.doc-card a.stretched-link::after { z-index: 1; }
|
|
151
|
+
|
|
152
|
+
/* ── Badges row ────────────────────────────────────────── */
|
|
153
|
+
.badge-row { margin-bottom: 1rem; line-height: 2; }
|
|
154
|
+
.badge-row img { margin-right: .25rem; }
|
|
155
|
+
|
|
156
|
+
/* ── ── ── DARK MODE ── ── ── ──────────────────────────── */
|
|
157
|
+
|
|
158
|
+
[data-bs-theme="dark"] body { background-color: #343739; color: #DFD7CA; }
|
|
159
|
+
|
|
160
|
+
[data-bs-theme="dark"] .navbar {
|
|
161
|
+
background: color-mix(in oklab, color-mix(in oklab, #343739 92%, var(--bs-primary)) 95%, #DFD7CA);
|
|
162
|
+
border-bottom-color: #495057;
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
[data-bs-theme="dark"] a { color: #7ba8d0; }
|
|
166
|
+
[data-bs-theme="dark"] a:hover { color: #a5c4e8; }
|
|
167
|
+
|
|
168
|
+
[data-bs-theme="dark"] .navbar .nav-link.active { color: #7ba8d0 !important; }
|
|
169
|
+
|
|
170
|
+
[data-bs-theme="dark"] h1,
|
|
171
|
+
[data-bs-theme="dark"] h2,
|
|
172
|
+
[data-bs-theme="dark"] h3,
|
|
173
|
+
[data-bs-theme="dark"] h4 { color: #DFD7CA; }
|
|
174
|
+
|
|
175
|
+
[data-bs-theme="dark"] h2 { border-color: #495057; }
|
|
176
|
+
|
|
177
|
+
[data-bs-theme="dark"] pre,
|
|
178
|
+
[data-bs-theme="dark"] div.sourceCode {
|
|
179
|
+
background-color: #2C2F31;
|
|
180
|
+
border-color: #495057;
|
|
181
|
+
color: #DFD7CA;
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
[data-bs-theme="dark"] code {
|
|
185
|
+
background-color: #2C2F31;
|
|
186
|
+
color: #DFD7CA;
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
[data-bs-theme="dark"] div.sourceCode span[class] { color: #DFD7CA !important; }
|
|
190
|
+
|
|
191
|
+
[data-bs-theme="dark"] thead th {
|
|
192
|
+
background-color: #3d4043;
|
|
193
|
+
color: #DFD7CA;
|
|
194
|
+
border-color: #495057;
|
|
195
|
+
}
|
|
196
|
+
[data-bs-theme="dark"] td,
|
|
197
|
+
[data-bs-theme="dark"] th { border-color: #3d4043; }
|
|
198
|
+
[data-bs-theme="dark"] tbody tr:hover { background-color: rgba(73,80,87,.3); }
|
|
199
|
+
|
|
200
|
+
[data-bs-theme="dark"] aside a { color: #8e9499; }
|
|
201
|
+
[data-bs-theme="dark"] aside a:hover { color: #7ba8d0; }
|
|
202
|
+
|
|
203
|
+
[data-bs-theme="dark"] .doc-card {
|
|
204
|
+
background: #2C2F31;
|
|
205
|
+
border-color: #495057;
|
|
206
|
+
}
|
|
207
|
+
[data-bs-theme="dark"] .doc-card:hover { border-color: #7ba8d0; }
|
|
208
|
+
[data-bs-theme="dark"] .doc-card p { color: #8e9499; }
|