chore: update docs (usememos#2094)

lincolnthalles · Oct 21, 2023 · 81e0bdc · 81e0bdc
1 parent cae66df
commit 81e0bdc
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 185 deletions.
diff --git a/docs/custom-themes.md b/docs/custom-themes.md
diff --git a/docs/deploy-with-render.md b/docs/deploy-with-render.md
diff --git a/docs/development-windows.md b/docs/development-windows.md
@@ -1,4 +1,4 @@
-# Development
+# Development in Windows
 
 Memos is built with a curated tech stack. It is optimized for developer experience and is very easy to start working on the code:
 
@@ -8,7 +8,7 @@ Memos is built with a curated tech stack. It is optimized for developer experien
 
 ## Tech Stack
 
-|                 Frontend                 |              Backend              |
+| Frontend                                 | Backend                           |
 | ---------------------------------------- | --------------------------------- |
 | [React](https://react.dev/)              | [Go](https://go.dev/)             |
 | [Tailwind CSS](https://tailwindcss.com/) | [SQLite](https://www.sqlite.org/) |
@@ -75,16 +75,16 @@ go build -o ./build/memos.exe ./main.go
 ## ❕ Notes
 
 - Start development servers easier by running the provided `start.ps1` script.
-This will start both backend and frontend in detached PowerShell windows:
+  This will start both backend and frontend in detached PowerShell windows:
 
-   ```powershell
-   .\scripts\start.ps1
-   ```
+  ```powershell
+  .\scripts\start.ps1
+  ```
 
 - Produce a local build easier using the provided `build.ps1` script to build both frontend and backend:
 
-   ```powershell
-   .\scripts\build.ps1
-   ```
+  ```powershell
+  .\scripts\build.ps1
+  ```
 
-   This will produce a memos.exe file in the ./build directory.
+  This will produce a memos.exe file in the ./build directory.
diff --git a/docs/setup.md b/docs/setup.md
diff --git a/docs/updates.md b/docs/updates.md
diff --git a/docs/windows-service.md b/docs/windows-service.md
@@ -24,7 +24,7 @@ nssm install memos "C:\path\to\memos.exe" --mode prod --port 5230
 nssm set memos DisplayName "memos service"
 
 # Configure extra service parameters
-nssm set memos Description "A lightweight, self-hosted memo hub. https://usememos.com/" 
+nssm set memos Description "A lightweight, self-hosted memo hub. https://usememos.com/"
 
 # Delay auto start
 nssm set memos Start SERVICE_DELAYED_AUTO_START
@@ -54,7 +54,7 @@ Now, in the same directory, create the service configuration file `memos-service
     <executable>%BASE%\memos.exe</executable>
     <arguments>--mode prod --port 5230</arguments>
     <delayedAutoStart>true</delayedAutoStart>
-    <log mode="none" />   
+    <log mode="none" />
 </service>
 ```
 
@@ -86,12 +86,12 @@ Also, by using one of the provided methods, the service will appear in the Windo
 
 - On Windows, memos store its data in the following directory:
 
-    ```powershell
-    $env:ProgramData\memos
-    # Typically, this will resolve to C:\ProgramData\memos
-    ```
+  ```powershell
+  $env:ProgramData\memos
+  # Typically, this will resolve to C:\ProgramData\memos
+  ```
 
-    You may specify a custom directory by appending `--data <path>` to the service command line.
+  You may specify a custom directory by appending `--data <path>` to the service command line.
 
 - If the service fails to start, you should inspect the Windows Event Viewer `eventvwr.msc`.