From 48aa1775a693a33768b019fc828117eb4d345dfc Mon Sep 17 00:00:00 2001 From: Luke Smith Date: Thu, 1 Jul 2021 08:45:52 -0400 Subject: more submission guidelines --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 31f4c3d..78663d2 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,35 @@ Simple step-by-step text and image-based tutorials for creating websites, email Suggestions welcome. -## Submissions +## Submission guidelines - follow the general style of pre-existing articles +- use the root user (i.e. no `sudo`) unless there is a specific need. +- do not preface commands with `$` or `#` or anything. - use `.svg` files for icons/logos and for illustrative images, keep filesize low +- Use `example.org` +- custom command/file info should be highlighted with `` tags + +### On `
` tags
+
+
+In-line code should be in `` tags, while codeblocks should be in a `` tag *inside* of a `
` tag.
+`
` allows formatting preserving whitespace.
+That said, do *not* format `
` tags as following:
+
+```
+

+	echo "Here is a command."
+	echo "Here is another."
+
+``` + +but do it like this: + +``` +
echo "Here is a command."
+echo "Here is another."
+``` + +**All** whitespace, including tabbing in and initial and final newlines are displayed by `
`.
+To maintain consistency and avoid goofy-looking extra lines, add no extra whitespace.
-- 
cgit v1.2.3