docs: format with prettier

schooltape · Jul 14, 2024 · cb7fd8d · cb7fd8d
1 parent d3aaceb
commit cb7fd8d
Show file tree

Hide file tree

Showing 8 changed files with 81 additions and 42 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,34 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 2
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# go
+[*.go]
+indent_style = tab
+indent_size = 4
+
+# python
+[*.{ini,py,py.tpl,rst}]
+indent_size = 4
+
+# rust
+[*.rs]
+indent_size = 4
+
+# documentation, utils
+[*.{md,mdx,diff}]
+trim_trailing_whitespace = false
+
+# windows shell scripts
+[*.{cmd,bat,ps1}]
+end_of_line = crlf
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,4 @@
+{
+    "printWidth": 120,
+    "bracketSameLine": true
+}
diff --git a/bun.lockb b/bun.lockb
diff --git a/package.json b/package.json
@@ -1,8 +1,8 @@
 {
   "devDependencies": {
     "markdownlint": "^0.34.0",
-    "prettier": "3.3.2",
-    "vitepress": "^1.2.3"
+    "prettier": "^3.3.3",
+    "vitepress": "^1.3.0"
   },
   "scripts": {
     "docs:dev": "vitepress dev",

diff --git a/src/compare.md b/src/compare.md
@@ -8,20 +8,20 @@ Lets compare the features of Schooltape to other Schoolbox web extensions.
 - Better Schoolbox: <https://github.com/ActuallyHappening/SchoolBoxStyling>
 - Schoolbox Dark Mode: <https://schoolbox-darkmode.web.app>
 
-| Features                  | Schooltape       | Coolbox | Better Schoolbox   | Schoolbox Dark Mode |
-| ------------------------- | ---------------- | ------- | ------------------ | ------------------- |
-| Works on any Schoolbox    | ✅               | ❌      | 🟠 Partial         | ❌                  |
-| Plugin ecosystem          | ✅               | ❌      | ❌                 | ❌                  |
-| Modern icons 🔌           | ✅               | ✅      | ❌                 | ❌                  |
-| Subheader revamp 🔌       | ✅               | ❓      | ❌                 | ❌                  |
-| Rearrangable homepage 🔌  | ❌ soon™         | ✅      | ❌                 | ❌                  |
-| Command palette 🔌        | ❌ soon™         | ❌      | ❌                 | ❌                  |
-| Themes                    | ✅               | ✅      | 🟠 Manual styling  | ✅                  |
-| Snippet ecosystem         | ✅               | ❌      | ❌                 | ❌                  |
-| Browser support           |                  |         |                    |                     |
-| Chrome                    | ✅               | ✅      | ✅                 | 🟠 Not on store     |
-| Firefox                   | ✅               | ✅      | ❌                 | 🟠 Unlisted         |
-| Edge                      | 🟠               | 🟠      | 🟠                 | 🟠                  |
-| Software info             |                  |         |                    |                     |
-| Open source               | ✅               | ✅      | ✅                 | ❌                  |
-| License                   | GPL-3.0          | MIT     | None               | None                |
+| Features                 | Schooltape | Coolbox | Better Schoolbox  | Schoolbox Dark Mode |
+| ------------------------ | ---------- | ------- | ----------------- | ------------------- |
+| Works on any Schoolbox   | ✅         | ❌      | 🟠 Partial        | ❌                  |
+| Plugin ecosystem         | ✅         | ❌      | ❌                | ❌                  |
+| Modern icons 🔌          | ✅         | ✅      | ❌                | ❌                  |
+| Subheader revamp 🔌      | ✅         | ❓      | ❌                | ❌                  |
+| Rearrangable homepage 🔌 | ❌ soon™  | ✅      | ❌                | ❌                  |
+| Command palette 🔌       | ❌ soon™  | ❌      | ❌                | ❌                  |
+| Themes                   | ✅         | ✅      | 🟠 Manual styling | ✅                  |
+| Snippet ecosystem        | ✅         | ❌      | ❌                | ❌                  |
+| Browser support          |            |         |                   |                     |
+| Chrome                   | ✅         | ✅      | ✅                | 🟠 Not on store     |
+| Firefox                  | ✅         | ✅      | ❌                | 🟠 Unlisted         |
+| Edge                     | 🟠         | 🟠      | 🟠                | 🟠                  |
+| Software info            |            |         |                   |                     |
+| Open source              | ✅         | ✅      | ✅                | ❌                  |
+| License                  | GPL-3.0    | MIT     | None              | None                |
diff --git a/src/contributing/index.md b/src/contributing/index.md
@@ -69,6 +69,7 @@ If you haven't used Git before, I'd highly recommend reading [Pro Git](https://g
 1. [Open an issue](https://github.com/schooltape/schooltape/issues/new?assignees=42willow&labels=enhancement&projects=&template=feature_request.yml) describing your change to get your idea approved
 
 2. Please read the specific guides on how to contribute your own:
+
    - [Plugins](./plugins.md)
    - [Themes](./themes.md)
    - [Snippets](./snippets.md)

diff --git a/src/contributing/snippets.md b/src/contributing/snippets.md
@@ -9,35 +9,35 @@ Please read the [contribution instructions](/contributing/) before contributing.
 1. Append your snippet to the bottom of `SNIPPET_INFO` in `src/utils/constants.ts`
     ```ts
     export const SNIPPET_INFO: Record<string, SnippetInfo> = {
-        hidePfp: {
-            name: "Hide PFP",
-            description: "Hide your profile picture across Schoolbox.",
-            order: 0,
-        },
-        // ..
-        <yourSnippetName>: { // [!code ++]
-            name: "<Your Snippet Name>", // [!code ++]
-            description: "<Your Snippet Description>", // [!code ++]
-            order: "<Next Order Number>", // [!code ++]
-        }, // [!code ++]
+      hidePfp: {
+        name: "Hide PFP",
+        description: "Hide your profile picture across Schoolbox.",
+        order: 0,
+      },
+      // ..
+      <yourSnippetName>: { // [!code ++]
+        name: "<Your Snippet Name>", // [!code ++]
+        description: "<Your Snippet Description>", // [!code ++]
+        order: "<Next Order Number>", // [!code ++]
+      }, // [!code ++]
     };
     ```
 2. Append your snippet to the bottom of `snippets` in `src/utils/storage.ts`
     ```ts
     export const snippetSettings = storage.defineItem<Types.SnippetSettings>("local:snippetSettings", {
+      // ..
+      defaultValue: {
         // ..
-        defaultValue: {
-            // ..
-            snippets: {
-                hidePfp: {
-                    toggle: true,
-                },
-                // ..
-                <yourSnippetName>: { // [!code ++]
-                    toggle: false, // [!code ++]
-                }, // [!code ++]
-            },
+        snippets: {
+          hidePfp: {
+            toggle: true,
+          },
+          // ..
+          <yourSnippetName>: { // [!code ++]
+            toggle: false, // [!code ++]
+          }, // [!code ++]
         },
+      },
     });
     ```
 3. Create a new file in `src/public/snippets` with the name `<yourSnippetName>.css`

diff --git a/src/installation/index.md b/src/installation/index.md
@@ -17,7 +17,7 @@ Schooltape is currently unavailable in the following web stores:
 - Edge Add-ons
 - Opera Add-ons
 - Safari Extensions
-:::
+  :::
 
 ## From GitHub releases