aboutsummaryrefslogtreecommitdiffstats
path: root/markdown
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2018-01-28 14:39:48 -0500
committerDrew DeVault <sir@cmpwn.com>2018-01-28 14:39:48 -0500
commitd124788519879f1392898cbd9dbc8cd57df21ea1 (patch)
tree92042ee09af156fa9f78eb7809c09fc1cec403ad /markdown
parent5444c46fb567ba19014181d0558a5edcdc1a6c6e (diff)
downloadsr.ht-docs-d124788519879f1392898cbd9dbc8cd57df21ea1.tar.gz
Add markdown specification
Diffstat (limited to 'markdown')
-rw-r--r--markdown/index.md58
1 files changed, 58 insertions, 0 deletions
diff --git a/markdown/index.md b/markdown/index.md
new file mode 100644
index 0000000..2e9c509
--- /dev/null
+++ b/markdown/index.md
@@ -0,0 +1,58 @@
+Across the site, sr.ht uses a consistent Markdown syntax based on Python's
+[Markdown](https://pypi.python.org/pypi/Markdown) package, which implements John
+Gruber's [original Markdown
+specification](https://pypi.python.org/pypi/Markdown).
+
+We then post-process the HTML to strip out unwanted tags and attributes.
+
+## Tags
+
+- a
+- abbr
+- acronym
+- b
+- blockquote
+- code
+- div
+- dd
+- dl
+- dt
+- em
+- h1, h2, h3, h4, h5
+- i
+- img
+- input
+- li
+- ol
+- p
+- pre
+- span
+- strong
+- table
+- tbody
+- thead
+- td
+- th
+- tr
+- ul
+
+## Attributes
+
+We allow the `id` attribute on `h*` tags and the `class` attribute on all tags -
+the only permitted values of `class` are:
+
+- `row`
+- `col-md-*`
+- `form-control`
+
+You may also specify the `style` tag, for which you may specify the following
+attributes:
+
+- `margin`
+- `padding`
+- `text-align`
+- `font-weight`
+- `text-decoration`
+
+`input` elements may specify `type='checkbox'` as well as the `checked`
+attribute.