You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
After installing mdBook, you'll need to clone the code via git and navigate to the directory.
26
26
@@ -52,6 +52,28 @@ mdbook build
52
52
53
53
Don't forget to remove the changes in `book.toml` before you commit!
54
54
55
+
## Writing style guide
56
+
57
+
This section contains what is a *somewhat loosely* applied style guide for writing that is contributed to `component-docs`.
58
+
59
+
### Executable code fragments
60
+
61
+
For code that should be executed by the user in their console of choice, prefer using `sh`/`bash`. While not every user's
62
+
shell is `sh` or `bash` (with `zsh` being incredilby common), `sh`/`bash` provide a decent approximation.
63
+
64
+
Importantly, code that is meant to be executed should be copy-pastable -- and should not contain `$` as a prefix. For example:
65
+
66
+
```sh
67
+
echo'this is an example';
68
+
```
69
+
70
+
On the other hand, when commands *and* output are shown, use `console` and *do* prefix the command with `$` to differentiate it (or `#` in a sudo context):
71
+
72
+
```console
73
+
$ echo'this is an example';
74
+
this is an example
75
+
```
76
+
55
77
## Submitting Changes
56
78
57
79
You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a fork. Make any changes you want in your fork, and when you are ready to submit those changes, go to your fork and create a new pull request to let us know about it.
0 commit comments