tenseleyflow/shithub / 959c1fd

Browse files

Document README presentation markdown

Authored by espadonne
SHA
959c1fdb0c9f70e5cc1a9fca38e5b607fa7a7e1f
Parents
0063bfe
Tree
4ac7cfe

2 changed files

StatusFile+-
M docs/markdown.md 3 0
M docs/public/user/markdown.md 5 3
docs/markdown.mdmodified
@@ -59,6 +59,9 @@ These tags pass through unchanged:
5959
 - `<details>` / `<summary>` (collapsible sections)
6060
 - `<kbd>` (keyboard markers)
6161
 - `<sup>`, `<sub>` (superscript / subscript)
62
+- README presentation attributes GitHub commonly allows:
63
+  `align="left|center|right"` on paragraphs / headings / divs,
64
+  and `width` / `height` on images.
6265
 - Standard text formatting tags Goldmark emits (em, strong, code,
6366
   pre, blockquote, ul, ol, li, table family).
6467
 
docs/public/user/markdown.mdmodified
@@ -93,9 +93,11 @@ shortcode list.
9393
 - **Footnotes** — not yet (planned).
9494
 - **MathJax / KaTeX** — not yet (planned).
9595
 - **Mermaid diagrams** — not yet (post-MVP).
96
-- **Image attributes** like `<img width="200">` — strip-and-render
97
-  without the attribute. Use markdown image syntax with a small
98
-  thumbnail upstream.
96
+
97
+README-style HTML alignment (`align="center"` on headings,
98
+paragraphs, or divs) and image dimensions (`<img width="200">`) are
99
+preserved because GitHub READMEs commonly use them for logos and
100
+badges.
99101
 
100102
 ## Why a sanitizer?
101103