forked from cory/tildefriends
chore(doc): run and modify formatting rules
This commit is contained in:
parent
0751699bc8
commit
85ac8080f4
@ -1,2 +1,5 @@
|
|||||||
default: true
|
default: true
|
||||||
|
MD010: false # Ignore tabs in code blocks
|
||||||
MD013: false # Don't wrap lines by default
|
MD013: false # Don't wrap lines by default
|
||||||
|
MD046:
|
||||||
|
style: "fenced" # Force fenced code blocks
|
||||||
|
@ -135,16 +135,18 @@ Sets the browser window/tab title.
|
|||||||
|
|
||||||
Reconfigures the terminal layout, potentially into multiple split panes.
|
Reconfigures the terminal layout, potentially into multiple split panes.
|
||||||
|
|
||||||
terminal.split([
|
```javascript
|
||||||
{
|
terminal.split(
|
||||||
type: "horizontal",
|
[{
|
||||||
children: [
|
type: "horizontal",
|
||||||
{name: "left", basis: "2in", grow: 0, shrink: 0},
|
children: [
|
||||||
{name: "middle", grow: 1},
|
{name: "left", basis: "2in", grow: 0, shrink: 0},
|
||||||
{name: "right", basis: "2in", grow: 0, shrink: 0},
|
{name: "middle", grow: 1},
|
||||||
],
|
{name: "right", basis: "2in", grow: 0, shrink: 0},
|
||||||
},
|
],
|
||||||
]);
|
}]
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
#### terminal.select(name)
|
#### terminal.select(name)
|
||||||
|
|
@ -28,7 +28,7 @@ Dependencies for Windows:
|
|||||||
|
|
||||||
2. Run `make -j $(nproc) debug` or `make -j $(nproc) release`
|
2. Run `make -j $(nproc) debug` or `make -j $(nproc) release`
|
||||||
|
|
||||||
> If you're unsure whether you should choose `debug` or `release`, stick to `release`.
|
If you're unsure whether you should choose `debug` or `release`, stick to `release`.
|
||||||
|
|
||||||
> `-j $(nproc)` will start a compiler for every CPU thread, which will dramatically reduce the time needed to compile Tilde Friends.
|
> `-j $(nproc)` will start a compiler for every CPU thread, which will dramatically reduce the time needed to compile Tilde Friends.
|
||||||
|
|
||||||
@ -44,13 +44,13 @@ Now that you have a binary, head over to <running.md>.
|
|||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### The compiler throws an error and I can't build the binary.
|
### The compiler throws an error and I can't build the binary
|
||||||
|
|
||||||
Open `GNUMakefile` and edit the CFLAGS environment variable around line 50.
|
Open `GNUMakefile` and edit the CFLAGS environment variable around line 50.
|
||||||
|
|
||||||
For example given this error:
|
For example given this error:
|
||||||
|
|
||||||
```
|
```text
|
||||||
src/http.c: In function ‘tf_http_get_cookie’:
|
src/http.c: In function ‘tf_http_get_cookie’:
|
||||||
src/http.c:1089:128: error: check of ‘name’ for NULL after already dereferencing it [-Werror=analyzer-deref-before-check]
|
src/http.c:1089:128: error: check of ‘name’ for NULL after already dereferencing it [-Werror=analyzer-deref-before-check]
|
||||||
```
|
```
|
||||||
|
@ -10,21 +10,22 @@ Alternatively, you can change the `origin` remote on your existing clone:
|
|||||||
|
|
||||||
- Make your changes
|
- Make your changes
|
||||||
|
|
||||||
- I want to edit C code !
|
- I want to edit C code !
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
|
||||||
- I want to edit JavaScript code !
|
- I want to edit JavaScript code !
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
|
||||||
- I want to write documentation !
|
- I want to write documentation !
|
||||||
|
|
||||||
Great! Before you do, have a look at the [documentation guidelines](guidelines/documentation-guidelines.md) to learn how to write consistent documentation.
|
Great! Before you do, have a look at the [documentation guidelines](guidelines/documentation-guidelines.md) to learn how to write consistent documentation.
|
||||||
|
|
||||||
In all cases:
|
In all cases:
|
||||||
|
|
||||||
- Make sure that your commit messages are descriptive.
|
- Make sure that your commit messages are descriptive.
|
||||||
|
<!-- - hi -->
|
||||||
|
|
||||||
- Format your changes:
|
- Format your changes:
|
||||||
|
|
||||||
|
@ -14,4 +14,6 @@ See <faq.md>.
|
|||||||
|
|
||||||
## Guide
|
## Guide
|
||||||
|
|
||||||
See <guide.md>.
|
This document will be phased out and integrated into the new documentation.
|
||||||
|
|
||||||
|
See <.guide.md>.
|
||||||
|
@ -4,6 +4,6 @@
|
|||||||
|
|
||||||
See <running.md>.
|
See <running.md>.
|
||||||
|
|
||||||
### The compiler throws an error and I can't build the binary.
|
### The compiler throws an error and I can't build the binary
|
||||||
|
|
||||||
See <building.md>.
|
See <building.md>.
|
||||||
|
@ -28,25 +28,25 @@ When writing documentation, the author should have in mind it's target audience:
|
|||||||
|
|
||||||
1. Lines SHOULD NOT be wrapped, to allow clients to dynamically wrap them however they want:
|
1. Lines SHOULD NOT be wrapped, to allow clients to dynamically wrap them however they want:
|
||||||
|
|
||||||
```
|
```text
|
||||||
This is not very pleasant to read because
|
This is not very pleasant to read because
|
||||||
the text
|
the text
|
||||||
is manually wrapped, but the size of the
|
is manually wrapped, but the size of the
|
||||||
screen is
|
screen is
|
||||||
smaller than the size the text is wrapped
|
smaller than the size the text is wrapped
|
||||||
at. I
|
at. I
|
||||||
need to write even more useless text here
|
need to write even more useless text here
|
||||||
so I get
|
so I get
|
||||||
my point across. Also hi! If you're here
|
my point across. Also hi! If you're here
|
||||||
that
|
that
|
||||||
means you're either going to contribute to
|
means you're either going to contribute to
|
||||||
Tilde
|
Tilde
|
||||||
Friends, or that you're reviewing my
|
Friends, or that you're reviewing my
|
||||||
stupid
|
stupid
|
||||||
changes. Either way, you're awesome!
|
changes. Either way, you're awesome!
|
||||||
```
|
```
|
||||||
|
|
||||||
You MAY use one line per sentence.
|
You MAY use one line per sentence.
|
||||||
|
|
||||||
2. Lines ending with an `inline code block` SHOULD NOT end with a period.
|
2. Lines ending with an `inline code block` SHOULD NOT end with a period.
|
||||||
|
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"format": "npm run prettier && npm run markdown",
|
"format": "npm run prettier && npm run markdown",
|
||||||
"prettier": "npx prettier --cache --write --check .",
|
"prettier": "npx prettier --cache --write --check .",
|
||||||
"markdown": "npx markdownlint-cli 'docs/**/*.md' -f"
|
"markdown": "npx markdownlint-cli --fix 'docs/**/*.md'"
|
||||||
},
|
},
|
||||||
"author": "Cory McWilliams",
|
"author": "Cory McWilliams",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
Loading…
Reference in New Issue
Block a user