summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJulian Jarabo <julian08@cock.li>2021-07-01 15:05:29 +0200
committerJulian Jarabo <julian08@cock.li>2021-07-01 15:05:29 +0200
commit3de536671c8c5c3d05478bd609971bf09beff6bd (patch)
tree1a6ad3798b1a9d9ae6194a8d63978ed058b1606b /README.md
parent288bb9891ca2b948117cf43bad1297ff79ab6235 (diff)
parenta0057185e401b1a1f8040a2e64bd692248c522c5 (diff)
Merge branch 'master' of https://github.com/lukesmithxyz/landchad
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 29 insertions, 1 deletions
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 `<strong>` tags
+
+### On `<pre>` tags
+
+
+In-line code should be in `<code>` tags, while codeblocks should be in a `<code>` tag *inside* of a `<pre>` tag.
+`<pre>` allows formatting preserving whitespace.
+That said, do *not* format `<pre>` tags as following:
+
+```
+<pre><code>
+ echo "Here is a command."
+ echo "Here is another."
+</code></pre>
+```
+
+but do it like this:
+
+```
+<pre><code>echo "Here is a command."
+echo "Here is another."</code></pre>
+```
+
+**All** whitespace, including tabbing in and initial and final newlines are displayed by `<pre>`.
+To maintain consistency and avoid goofy-looking extra lines, add no extra whitespace.