orz-markdown 1.3.1 → 1.3.2
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/README.md +8 -0
- package/package.json +1 -1
- package/themes/common.css +9 -2
package/README.md
CHANGED
|
@@ -1,9 +1,17 @@
|
|
|
1
1
|
# orz-markdown
|
|
2
2
|
|
|
3
|
+
[](https://doi.org/10.5281/zenodo.21099237)
|
|
4
|
+
|
|
3
5
|
A deeply customized markdown-it parser configured with several official plugins and many custom plugins designed to render interactive objects, embedded rich media, and invisible data. Crafted alongside beautifully optimized CSS themes for an excellent out-of-the-box rendering experience. An agent skill is available for using this markdown parser with AI agents.
|
|
4
6
|
|
|
5
7
|
Rendered HTML is intended to live inside a `.markdown-body` container and be paired with one of the bundled themes.
|
|
6
8
|
|
|
9
|
+
## Citation
|
|
10
|
+
|
|
11
|
+
If you use or cite the orz-markdown website or editable document family, please cite the archived release:
|
|
12
|
+
|
|
13
|
+
Yu Wang. (2026). orz-markdown: a Markdown family that travels in one file. Zenodo. https://doi.org/10.5281/zenodo.21099237
|
|
14
|
+
|
|
7
15
|
## Installation
|
|
8
16
|
|
|
9
17
|
Install the package via npm:
|
package/package.json
CHANGED
package/themes/common.css
CHANGED
|
@@ -10,12 +10,19 @@
|
|
|
10
10
|
|
|
11
11
|
.markdown-body img {
|
|
12
12
|
display: block;
|
|
13
|
-
width: auto;
|
|
14
13
|
max-width: 100%;
|
|
15
14
|
max-height: 100%;
|
|
16
|
-
height: auto;
|
|
17
15
|
object-fit: contain;
|
|
18
16
|
}
|
|
17
|
+
/* Responsive by default, but explicit dimensions from ``
|
|
18
|
+
(markdown-it-imsize → width/height attributes) must win: only auto-size
|
|
19
|
+
images that DON'T carry an explicit width/height. */
|
|
20
|
+
.markdown-body img:not([width]) {
|
|
21
|
+
width: auto;
|
|
22
|
+
}
|
|
23
|
+
.markdown-body img:not([height]) {
|
|
24
|
+
height: auto;
|
|
25
|
+
}
|
|
19
26
|
|
|
20
27
|
.markdown-body p > img {
|
|
21
28
|
display: inline;
|