From 85ac8080f4f88517eb97f0469bcab3868ad8ae74 Mon Sep 17 00:00:00 2001 From: Tasia Iso Date: Sat, 11 May 2024 21:47:47 +0200 Subject: [PATCH] chore(doc): run and modify formatting rules --- .markdownlint.yaml | 3 ++ docs/{guide.md => .guide.md} | 22 +++++++------ docs/building.md | 6 ++-- docs/contributing.md | 7 ++-- docs/documentation.md | 4 ++- docs/faq.md | 2 +- docs/guidelines/documentation-guidelines.md | 36 ++++++++++----------- package.json | 2 +- 8 files changed, 45 insertions(+), 37 deletions(-) rename docs/{guide.md => .guide.md} (96%) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 816a7188..aa88abf7 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,2 +1,5 @@ default: true +MD010: false # Ignore tabs in code blocks MD013: false # Don't wrap lines by default +MD046: + style: "fenced" # Force fenced code blocks diff --git a/docs/guide.md b/docs/.guide.md similarity index 96% rename from docs/guide.md rename to docs/.guide.md index f815f911..31da05ca 100644 --- a/docs/guide.md +++ b/docs/.guide.md @@ -135,16 +135,18 @@ Sets the browser window/tab title. Reconfigures the terminal layout, potentially into multiple split panes. - terminal.split([ - { - type: "horizontal", - children: [ - {name: "left", basis: "2in", grow: 0, shrink: 0}, - {name: "middle", grow: 1}, - {name: "right", basis: "2in", grow: 0, shrink: 0}, - ], - }, - ]); +```javascript +terminal.split( + [{ + type: "horizontal", + children: [ + {name: "left", basis: "2in", grow: 0, shrink: 0}, + {name: "middle", grow: 1}, + {name: "right", basis: "2in", grow: 0, shrink: 0}, + ], + }] +); +``` #### terminal.select(name) diff --git a/docs/building.md b/docs/building.md index a2d4a62c..73b5b987 100644 --- a/docs/building.md +++ b/docs/building.md @@ -28,7 +28,7 @@ Dependencies for Windows: 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. @@ -44,13 +44,13 @@ Now that you have a binary, head over to . ## 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. For example given this error: -``` +```text 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] ``` diff --git a/docs/contributing.md b/docs/contributing.md index 4804ee11..378240fb 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -10,21 +10,22 @@ Alternatively, you can change the `origin` remote on your existing clone: - Make your changes - - I want to edit C code ! + - I want to edit C code ! TODO - - I want to edit JavaScript code ! + - I want to edit JavaScript code ! 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. In all cases: - Make sure that your commit messages are descriptive. + - Format your changes: diff --git a/docs/documentation.md b/docs/documentation.md index 2fc7a476..21b042ce 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -14,4 +14,6 @@ See . ## Guide -See . +This document will be phased out and integrated into the new documentation. + +See <.guide.md>. diff --git a/docs/faq.md b/docs/faq.md index 67d2f29a..27ca2a45 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -4,6 +4,6 @@ See . -### 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 . diff --git a/docs/guidelines/documentation-guidelines.md b/docs/guidelines/documentation-guidelines.md index 039434dc..7c5acf42 100644 --- a/docs/guidelines/documentation-guidelines.md +++ b/docs/guidelines/documentation-guidelines.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: -``` -This is not very pleasant to read because -the text -is manually wrapped, but the size of the -screen is -smaller than the size the text is wrapped -at. I -need to write even more useless text here -so I get -my point across. Also hi! If you're here -that -means you're either going to contribute to -Tilde -Friends, or that you're reviewing my -stupid -changes. Either way, you're awesome! -``` + ```text + This is not very pleasant to read because + the text + is manually wrapped, but the size of the + screen is + smaller than the size the text is wrapped + at. I + need to write even more useless text here + so I get + my point across. Also hi! If you're here + that + means you're either going to contribute to + Tilde + Friends, or that you're reviewing my + stupid + 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. diff --git a/package.json b/package.json index e54d10b0..04c95411 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "scripts": { "format": "npm run prettier && npm run markdown", "prettier": "npx prettier --cache --write --check .", - "markdown": "npx markdownlint-cli 'docs/**/*.md' -f" + "markdown": "npx markdownlint-cli --fix 'docs/**/*.md'" }, "author": "Cory McWilliams", "license": "MIT",