Document README presentation markdown
- SHA
959c1fdb0c9f70e5cc1a9fca38e5b607fa7a7e1f- Parents
-
0063bfe - Tree
4ac7cfe
tenseleyflow/shithub
/
959c1fd
Browse files
2 changed files
| Status | File | + | - |
|---|---|---|---|
| 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: | |||
| 59 | - `<details>` / `<summary>` (collapsible sections) | 59 | - `<details>` / `<summary>` (collapsible sections) |
| 60 | - `<kbd>` (keyboard markers) | 60 | - `<kbd>` (keyboard markers) |
| 61 | - `<sup>`, `<sub>` (superscript / subscript) | 61 | - `<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. | ||
| 62 | - Standard text formatting tags Goldmark emits (em, strong, code, | 65 | - Standard text formatting tags Goldmark emits (em, strong, code, |
| 63 | pre, blockquote, ul, ol, li, table family). | 66 | pre, blockquote, ul, ol, li, table family). |
| 64 | 67 | ||
docs/public/user/markdown.mdmodified@@ -93,9 +93,11 @@ shortcode list. | |||
| 93 | - **Footnotes** — not yet (planned). | 93 | - **Footnotes** — not yet (planned). |
| 94 | - **MathJax / KaTeX** — not yet (planned). | 94 | - **MathJax / KaTeX** — not yet (planned). |
| 95 | - **Mermaid diagrams** — not yet (post-MVP). | 95 | - **Mermaid diagrams** — not yet (post-MVP). |
| 96 | -- **Image attributes** like `<img width="200">` — strip-and-render | 96 | + |
| 97 | - without the attribute. Use markdown image syntax with a small | 97 | +README-style HTML alignment (`align="center"` on headings, |
| 98 | - thumbnail upstream. | 98 | +paragraphs, or divs) and image dimensions (`<img width="200">`) are |
| 99 | +preserved because GitHub READMEs commonly use them for logos and | ||
| 100 | +badges. | ||
| 99 | 101 | ||
| 100 | ## Why a sanitizer? | 102 | ## Why a sanitizer? |
| 101 | 103 | ||