Add plugin documentation and prettier

Author: nabeelio

.github/workflows/publish.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: '21.x'
+          node-version: '22.x'
       - name: Test Build
         run: |
           if [ -e yarn.lock ]; then
@@ -32,7 +32,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: '21.x'
+          node-version: '22.x'
       - name: Add key to allow access to repository
         env:
           SSH_AUTH_SOCK: /tmp/ssh_agent.sock

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "bracketSpacing": false,
+  "jsxBracketSameLine": true,
+
+  "printWidth": 80,
+  "proseWrap": "always",
+  "singleQuote": true,
+  "trailingComma": "all"
+}

Dockerfile

@@ -5,6 +5,6 @@ WORKDIR /app/website
 EXPOSE 3000 35729
 COPY ./docs /app/docs
 COPY ./website /app/website
-RUN yarn install
+RUN npm install
 
-CMD ["yarn", "start"]
+CMD ["npm", "start"]

README.md

@@ -1,6 +1,7 @@
 # Website
 
-This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
+This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern
+static website generator.
 
 ### Installation
 
@@ -14,20 +15,23 @@ $ yarn
 $ yarn start
 ```
 
-This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+This command starts a local development server and open up a browser window.
+Most changes are reflected live without having to restart the server.
 
 ### Build
 
 ```
 $ yarn build
 ```
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+This command generates static content into the `build` directory and can be
+served using any static contents hosting service.
 
 ### Deployment
 
 ```
 $ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
 ```
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+If you are using GitHub pages for hosting, this command is a convenient way to
+build the website and push to the `gh-pages` branch.

docs/acars/customization.md

@@ -0,0 +1,76 @@
+---
+id: customization
+title: Customization
+---
+
+## Logo Images
+
+You can add your logo to the splash screen and the dashboard. They will be
+resized down to fit. Fill in the URLs to your logos. They should be PNG format
+(transparency is supported):
+
+- **Splash Screen Banner** _Premium License Required_ - This replaces the large
+  phpVMS splash screen. 500x375 recommended for best look, anything larger will
+  be scaled down to the size.
+- **Splash Screen Logo** - This adds a small logo to the bottom right of the
+  splash screen. This can be combined with the splash screen banner. This will
+  be sized to 150x150
+- **Dashboard Logo** - This places a logo onto the dashboard, to the right of
+  the user profile. This will be sized to 300x64 max.
+- **Dashboard Logo Dark** - The logo to use for dark mode. If empty, it'll just
+  use the Dashboard Logo
+
+![](img/logo-urls.png)
+
+---
+
+## Discord Rich Presence
+
+:::tip This requires the ACARS Premium Addon :::
+
+To customize the "Rich Presence" dialog in Discord, you need to create a new
+Application in Discord. You'll then enter the provided `Application ID` into the
+admin panel. If you don't set this, the default "vmsACARS" application will be
+used.
+
+![](img/discord.png)
+
+#### 1. Create the Application
+
+Visit
+[Discord Application Developer site](https://discord.com/developers/applications),
+and select "New Application". I suggest using your VA name, it will say
+something like "Playing (whatever you enter)" (or something like "VA Name
+ACARS")
+
+![Default Rich Presence](img/discord-new-app.png)
+
+Upload your logo and title it appropriately. **Make note of the "Application ID"
+here, this will go into the admin panel.**
+
+#### 2. Add your logos to the art assets
+
+Next, go to "Rich Presence" and then "Art Assets". Add your cover image here,
+and add a new **Rich Presence Asset** titled `logo`. This will be used in the
+mini box that shows up
+
+:::note
+
+The logo asset added must be titled `logo`
+
+:::
+
+![](img/discord-assets.png)
+
+#### 3. Set the application ID
+
+Set the application ID in the admin panel.
+
+![](img/discord-app-id.png)
+
+## Custom Configs
+
+:::tip This requires the ACARS Premium Addon :::
+
+You can create a zip file and upload your custom configurations. Follow the
+instructions in the [acars-pdk](https://github.com/phpvms/acars-pdk) repository.