From d03e0719d51a4965a3d97c7af3c75eb467be0c24 Mon Sep 17 00:00:00 2001
From: Sean Madsen <sean@seanmadsen.com>
Date: Wed, 25 Jan 2017 17:47:28 -0700
Subject: [PATCH] markdownrules - adding markdown standards to close #70
---
docs/markdownrules.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/docs/markdownrules.md b/docs/markdownrules.md
index 158be8fe..8fec285e 100644
--- a/docs/markdownrules.md
+++ b/docs/markdownrules.md
@@ -18,6 +18,16 @@ this book is
[here](http://www.mkdocs.org/user-guide/writing-your-docs).
+## CiviCRM markdown code standards {:#standards}
+
+To maintain some consistency and peace of mind for documentation content editors, we've [agreed](https://github.com/civicrm/civicrm-dev-docs/issues/43) to *recommend* the following syntax as markdown code standards. These are not hard rules though.
+
+* **Line length:** write long lines (i.e. one line per paragraph) and set your text editor to view them with a "soft wrap".
+* **Ordered lists:** use `1.` as delimiters.
+* **Unordered lists:** use `*` to delimiters.
+* **Headings:** use hashes like `## Heading 2`.
+
+
## Basics
- `*italics*`
--
GitLab