chore: wip

Author: Chris Breuer

docs/config.md

@@ -12,24 +12,30 @@ import path from 'node:path'
 
 const config: ReverseProxyOptions = {
   /**
-   * The from URL to proxy from.
-   * Default: localhost:5173
+
+   _ The from URL to proxy from.
+   _ Default: localhost:5173
+
    */
   from: 'localhost:5173',
 
   /**
-   * The to URL to proxy to.
-   * Default: stacks.localhost
+
+   _ The to URL to proxy to.
+   _ Default: stacks.localhost
+
    */
   to: 'stacks.localhost',
 
   /**
-   * The HTTPS settings.
-   * Default: true
-   * If set to false, the proxy will use HTTP.
-   * If set to true, the proxy will use HTTPS.
-   * If set to an object, the proxy will use HTTPS with the provided settings.
-   */
+
+   _ The HTTPS settings.
+   _ Default: true
+   _ If set to false, the proxy will use HTTP.
+   _ If set to true, the proxy will use HTTPS.
+   _ If set to an object, the proxy will use HTTPS with the provided settings.
+
+   _/
   https: {
     domain: 'stacks.localhost',
     hostCertCN: 'stacks.localhost',
@@ -48,10 +54,12 @@ const config: ReverseProxyOptions = {
   },
 
   /**
-   * The verbose setting.
-   * Default: false
-   * If set to true, the proxy will log more information.
-   */
+
+   _ The verbose setting.
+   _ Default: false
+   _ If set to true, the proxy will log more information.
+
+   _/
   verbose: false,
 }
 

docs/cron-expressions.md

@@ -14,15 +14,17 @@ A cron expression consists of five fields that specify when a job should run:
 │ │ │ │ ┌───────────── day of week (0 - 6) (Sunday to Saturday)
 │ │ │ │ │
 │ │ │ │ │
+
 * * * * *
+
 ```
 
 ### Special Characters
 
-- `*`: Matches any value (wildcard)
-- `,`: Separates multiple values (e.g., `1,3,5`)
-- `-`: Specifies a range (e.g., `1-5`)
-- `/`: Specifies a step value (e.g., `*/2` means every 2 units)
+* `*`: Matches any value (wildcard)
+* `,`: Separates multiple values (e.g., `1,3,5`)
+* `-`: Specifies a range (e.g., `1-5`)
+* `/`: Specifies a step value (e.g., `*/2` means every 2 units)
 
 ## Common Cron Expressions
 
@@ -51,7 +53,7 @@ Example with timezone:
 ```typescript
 await queue.scheduleCron({
   cronExpression: '30 9 * * *', // Every day at 9:30am
-  timezone: 'America/New_York', // Eastern Time
+  timezone: 'America/New*York', // Eastern Time
   data: {
     // job data
   }
@@ -60,15 +62,15 @@ await queue.scheduleCron({
 
 ### Common Timezones
 
-- `UTC`: Coordinated Universal Time
-- `America/New_York`: Eastern Time (US & Canada)
-- `America/Chicago`: Central Time (US & Canada)
-- `America/Denver`: Mountain Time (US & Canada)
-- `America/Los_Angeles`: Pacific Time (US & Canada)
-- `Europe/London`: UK time
-- `Europe/Paris`: Central European Time
-- `Asia/Tokyo`: Japan Standard Time
-- `Australia/Sydney`: Australian Eastern Time
+* `UTC`: Coordinated Universal Time
+* `America/New*York`: Eastern Time (US & Canada)
+* `America/Chicago`: Central Time (US & Canada)
+* `America/Denver`: Mountain Time (US & Canada)
+* `America/Los*Angeles`: Pacific Time (US & Canada)
+* `Europe/London`: UK time
+* `Europe/Paris`: Central European Time
+* `Asia/Tokyo`: Japan Standard Time
+* `Australia/Sydney`: Australian Eastern Time
 
 ## Advanced Examples
 
@@ -128,5 +130,5 @@ await queue.unscheduleCron('daily-job')
 
 ## Additional Resources
 
-- [Crontab Guru](https://crontab.guru/): Interactive cron expression editor
-- [List of TZ database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones): Complete list of valid timezone identifiers
+* [Crontab Guru](https://crontab.guru/): Interactive cron expression editor
+* [List of TZ database time zones](https://en.wikipedia.org/wiki/List*of*tz*database*time*zones): Complete list of valid timezone identifiers

docs/index.md

@@ -28,6 +28,4 @@ features:
   - title: "Binary"
     icon: "🚀"
     details: "Automatically builds a binary for your project out of your CLI."
----
-
-<Home />
+---

docs/intro.md

@@ -13,11 +13,11 @@ This is an opinionated TypeScript Starter kit to help kick-start development of
 It's rather simple to get your package development started:
 
 ```bash
-# you may use this GitHub template or the following command:
+# you may use this GitHub template or the following command
 bunx degit stacksjs/bun-queue my-pkg
 cd my-pkg
 
- # if you don't have pnpm installed, run `npm i -g pnpm`
+# if you don't have pnpm installed, run `npm i -g pnpm`
 bun i # install all deps
 bun run build # builds the library for production-ready use