chore(doc): run and modify formatting rules
This commit is contained in:
		@@ -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",
 | 
					        type: "horizontal",
 | 
				
			||||||
        children: [
 | 
					        children: [
 | 
				
			||||||
            {name: "left", basis: "2in", grow: 0, shrink: 0},
 | 
					            {name: "left", basis: "2in", grow: 0, shrink: 0},
 | 
				
			||||||
            {name: "middle", grow: 1},
 | 
					            {name: "middle", grow: 1},
 | 
				
			||||||
            {name: "right", basis: "2in", grow: 0, shrink: 0},
 | 
					            {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]
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -25,6 +25,7 @@ Alternatively, you can change the `origin` remote on your existing clone:
 | 
				
			|||||||
    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,7 +28,7 @@ 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
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -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",
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user