diff options
| author | Luke Smith <luke@lukesmith.xyz> | 2021-07-01 13:42:47 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-01 13:42:47 -0400 |
| commit | 40a71d15124cbeb472919e49296fd289bb18acaf (patch) | |
| tree | fa3a840eb19e547b3bf14d3c5282cc106757fdc3 /README.md | |
| parent | 09e8d8df7a96cae0b9b12af236a7f6958e79fe70 (diff) | |
| parent | b52ddb17e8f505f70ed98e8a87268b411511b128 (diff) | |
Merge branch 'master' into master
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 29 insertions, 1 deletions
@@ -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. |
