Merge pull request #18 from evex-dev/edamame-x

docs: New Document Site 🎉

.github/workflows/docs_site_build.yml

@@ -0,0 +1,63 @@
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      # - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: |
+          npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+          touch docs/.vitepress/dist/.nojekyll
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs/.vitepress/dist
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/pull_request.yml

@@ -0,0 +1,31 @@
+name: pull_request
+on:
+  pull_request:
+    branches: ['*']
+    paths-ignore:
+      - 'docs/**'
+      - '.vscode/**'
+      - 'README.md'
+      - '.gitignore'
+      - 'LICENSE'
+
+jobs:
+  jsr-dry-run:
+    name: "Checking if it's valid for JSR"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: v1.x
+      - run: deno publish --dry-run
+
+  deno:
+    name: 'Deno'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: denoland/setup-deno@v1
+        with:
+          deno-version: v1.x
+      - run: deno test

.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
 sandbox
+.env

README.md

@@ -6,9 +6,11 @@
 ![release workflow](https://github.com/evex-dev/linejs/actions/workflows/release.yml/badge.svg)\
 [![](https://dcbadge.limes.pink/api/server/evex)](https://discord.gg/evex)
 
-<img src="./.github/assets/icon.png" width="150" height="150" alt="LINEJS" />
+<center>
+  <img src="./.github/assets/icon.png" width="150"   height="150" alt="LINEJS" />
+</center>
 
-**LINEJS** is a JavaScript library for LINE SelfBot.
+<center> <b>LINEJS</b> is a JavaScript library for LINE SelfBot. </center>
 
 ---
 
@@ -100,8 +102,8 @@ await client.login({
 
 - Owner & Developer [Piloking](https://github.com/piloking)
 - Developer [EdamAme-x](https://github.com/EdamAme-x)
-- Developer [Hafusun](https://github.com/hafusun)
 - Developer [MocA-Love](https://github.com/MocA-Love)
+- Developer [Hafusun](https://github.com/hafusun)
 
 ## ToDo
 

docs/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.vitepress/cache/deps

docs/.vitepress/config.mts

@@ -0,0 +1,72 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "LINEJS Documentation",
+  titleTemplate: ":title | LINEJS",
+  description: "Documentation of LINEJS | LINEJS is a JavaScript library for LINE SelfBot.",
+  sitemap: {
+    hostname: 'https://linejs.evex.land',
+  },
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    siteTitle: 'LINEJS Docs',
+    search: {
+      provider: 'local'
+    },
+
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Docs', link: '/docs/start' },
+      { text: 'Examples', link: 'https://github.com/evex-dev/linejs' }
+    ],
+
+    sidebar: [
+      {
+        text: 'Docs',
+        items: [
+          { text: 'Start', link: '/docs/start' },
+          { text: 'Start 2', link: '/docs/start-2' },
+          { text: 'Message Event', link: '/docs/message-event' },
+        ]
+      },
+      {
+        text: 'Guides',
+        items: [
+          { text: 'Authors', link: '/docs/authors' },
+          { text: 'Question', link: '/docs/question' }
+        ]
+      }
+    ],
+
+    editLink: {
+      pattern: 'https://github.com/evex-dev/linejs/edit/main/docs/:path',
+      text: 'Edit this page on GitHub',
+    },
+
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright:
+        'Copyright © '+ new Date().getFullYear() +  '-present Evex Developers.',
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/evex-dev/linejs' },
+      { icon: 'discord', link: 'https://evex.land' }
+    ]
+  },
+  head: [
+    ['link', { rel: 'icon shortcut', href: '/favicon.png' }],
+    ['link', { rel: 'apple-touch-icon', href: '/favicon.png' }],
+    ['meta', { name: 'og:title', content: 'LINEJS Documentation' }],
+    ['meta', { name: 'og:image', content: 'https://linejs.evex.land/favicon.png' }],
+    ['meta', { name: 'og:description', content: 'LINEJS Documentation | LINEJS is a JavaScript library for LINE SelfBot.' }],
+    ['meta', { name: 'og:url', content: 'https://linejs.evex.land' }],
+    ['meta', { name: 'twitter:title', content: 'LINEJS Documentation' }],
+    ['meta', { name: 'twitter:description', content: 'LINEJS Documentation | LINEJS is a JavaScript library for LINE SelfBot.' }],
+    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
+    ['meta', { name: 'twitter:site', content: '@amex2189' }],
+    ['meta', { name: 'twitter:creator', content: '@amex2189' }],
+    ['meta', { name: 'twitter:image', content: 'https://linejs.evex.land/favicon.png' }],
+  ],
+})

docs/.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+
+  }
+} satisfies Theme

docs/.vitepress/theme/style.css

@@ -0,0 +1,139 @@
+/**
+ * Customize default theme styling by overriding CSS variables:
+ * https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
+ */
+
+/**
+ * Colors
+ *
+ * Each colors have exact same color scale system with 3 levels of solid
+ * colors with different brightness, and 1 soft color.
+ * 
+ * - `XXX-1`: The most solid color used mainly for colored text. It must
+ *   satisfy the contrast ratio against when used on top of `XXX-soft`.
+ *
+ * - `XXX-2`: The color used mainly for hover state of the button.
+ *
+ * - `XXX-3`: The color for solid background, such as bg color of the button.
+ *   It must satisfy the contrast ratio with pure white (#ffffff) text on
+ *   top of it.
+ *
+ * - `XXX-soft`: The color used for subtle background such as custom container
+ *   or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
+ *   on top of it.
+ *
+ *   The soft color must be semi transparent alpha channel. This is crucial
+ *   because it allows adding multiple "soft" colors on top of each other
+ *   to create a accent, such as when having inline code block inside
+ *   custom containers.
+ *
+ * - `default`: The color used purely for subtle indication without any
+ *   special meanings attched to it such as bg color for menu hover state.
+ *
+ * - `brand`: Used for primary brand colors, such as link text, button with
+ *   brand theme, etc.
+ *
+ * - `tip`: Used to indicate useful information. The default theme uses the
+ *   brand color for this by default.
+ *
+ * - `warning`: Used to indicate warning to the users. Used in custom
+ *   container, badges, etc.
+ *
+ * - `danger`: Used to show error, or dangerous message to the users. Used
+ *   in custom container, badges, etc.
+ * -------------------------------------------------------------------------- */
+
+ :root {
+  --vp-c-default-1: var(--vp-c-gray-1);
+  --vp-c-default-2: var(--vp-c-gray-2);
+  --vp-c-default-3: var(--vp-c-gray-3);
+  --vp-c-default-soft: var(--vp-c-gray-soft);
+
+  --vp-c-brand-1: var(--vp-c-indigo-1);
+  --vp-c-brand-2: var(--vp-c-indigo-2);
+  --vp-c-brand-3: var(--vp-c-indigo-3);
+  --vp-c-brand-soft: var(--vp-c-indigo-soft);
+
+  --vp-c-tip-1: var(--vp-c-brand-1);
+  --vp-c-tip-2: var(--vp-c-brand-2);
+  --vp-c-tip-3: var(--vp-c-brand-3);
+  --vp-c-tip-soft: var(--vp-c-brand-soft);
+
+  --vp-c-warning-1: var(--vp-c-yellow-1);
+  --vp-c-warning-2: var(--vp-c-yellow-2);
+  --vp-c-warning-3: var(--vp-c-yellow-3);
+  --vp-c-warning-soft: var(--vp-c-yellow-soft);
+
+  --vp-c-danger-1: var(--vp-c-red-1);
+  --vp-c-danger-2: var(--vp-c-red-2);
+  --vp-c-danger-3: var(--vp-c-red-3);
+  --vp-c-danger-soft: var(--vp-c-red-soft);
+}
+
+/**
+ * Component: Button
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-button-brand-border: transparent;
+  --vp-button-brand-text: var(--vp-c-white);
+  --vp-button-brand-bg: #006200;
+  --vp-button-brand-hover-border: transparent;
+  --vp-button-brand-hover-text: var(--vp-c-white);
+  --vp-button-brand-hover-bg: #076907;
+  --vp-button-brand-active-border: transparent;
+  --vp-button-brand-active-text: var(--vp-c-white);
+  --vp-button-brand-active-bg: #479947;
+}
+
+/**
+ * Component: Home
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-home-hero-name-color: transparent;
+  --vp-home-hero-name-background: -webkit-linear-gradient(
+    120deg,
+    #41d1ff 30%,
+    #00B900
+  );
+
+  --vp-home-hero-image-background-image: linear-gradient(
+    -45deg,
+    #ffB9ff 50%,
+    #69dbff 50%
+  );
+  --vp-home-hero-image-filter: blur(45px);
+}
+
+@media (min-width: 640px) {
+  :root {
+    --vp-home-hero-image-filter: blur(56px);
+  }
+}
+
+@media (min-width: 960px) {
+  :root {
+    --vp-home-hero-image-filter: blur(68px);
+  }
+}
+
+/**
+ * Component: Custom Block
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-custom-block-tip-border: transparent;
+  --vp-custom-block-tip-text: var(--vp-c-text-1);
+  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
+  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
+}
+
+/**
+ * Component: Algolia
+ * -------------------------------------------------------------------------- */
+
+.DocSearch {
+  --docsearch-primary-color: var(--vp-c-brand-1) !important;
+}
+

docs/deno.json

@@ -0,0 +1,8 @@
+{
+    "tasks": {
+        "vp": "deno run -A npm:vitepress"
+    },
+    "unstable": [
+        "byonm"
+    ]
+}

docs/docs/authors.md

@@ -0,0 +1,10 @@
+# Authors
+Maintainers of **LINEJS**
+
+## Maintainers
+- Owner & Developer [Piloking](https://github.com/piloking)
+- Developer [EdamAme-x](https://github.com/EdamAme-x)
+
+## Sub-maintainers
+- Developer [MocA-Love](https://github.com/MocA-Love)
+- Developer [Hafusun](https://github.com/hafusun)

docs/docs/message-event.md

@@ -0,0 +1,2 @@
+# Receive Message Event
+Coming soon...

docs/docs/question.md

@@ -0,0 +1,4 @@
+# Question
+This is our server. Feel free to ask questions!
+
+[https://discord.gg/evex](https://discord.gg/evex)