docs: haracho.approver.dev の monorepo 化 (#933)

.github/ISSUE_TEMPLATE/content_report.yml

@@ -0,0 +1,20 @@
+name: ドキュメント
+description: ドキュメントに関するIssueを提出します。
+labels: ["T-Documents"]
+body:
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: 提出する前に - 確認事項
+      description: 提出する前に確認する事項です。
+      options:
+        - label: 同一Issueはないか確認しましたか？
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: 提出内容
+      description: >
+        提出する内容を入力してください。
+    validations:
+      required: true

.github/codeql/codeql-config.yml

@@ -1,4 +1,5 @@
 paths:
   - src
+  - docs
 paths-ignore:
   - '**/*.md'

.github/labeler.yml

@@ -1,2 +1,8 @@
 C-GitHub Actions:
   - .github/workflows/*.yml
+
+T-OreOreBot2:
+  - src/**
+
+T-Documents:
+  - docs/**

.github/labels.yml

@@ -1,6 +1,14 @@
 # OreOreBot2 ラベルファイル
 # ラベル等の編集はこのファイルを編集してください。 main ブランチ更新後 CI が動き出し同期を開始します。
 
+# T - Type
+- name: 'T-OreOreBot2'
+  description: 'Type: OreOreBot2'
+  color: '8597FF'
+- name: 'T-Documents'
+  description: 'Type: Documents'
+  color: 'F0FF77'
+
 # C - Category
 - name: 'C-bug'
   description: 'Category: bug'

.github/workflows/docs_build.yml

@@ -0,0 +1,36 @@
+# OreOreBot2 Documents をビルドします。
+
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+
+jobs:
+  build:
+    name: Build (haracho.approvers.dev)
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docs
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: yarn
+
+      - name: Install packages
+        run: yarn install --immutable
+      - name: Build (haracho.approvers.dev)
+        run: yarn run build

.github/workflows/docs_eslint.yml

@@ -0,0 +1,36 @@
+# OreOreBot2 Documents に対して eslint を実行します。
+
+name: eslint
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+
+jobs:
+  eslint:
+    name: eslint
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docs
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: yarn
+
+      - name: Install packages
+        run: yarn install --immutable
+      - name: eslint
+        run: yarn run lint

.gitignore

@@ -6,6 +6,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+.pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -54,6 +55,9 @@ web_modules/
 # Optional eslint cache
 .eslintcache
 
+# Optional stylelint cache
+.stylelintcache
+
 # Microbundle cache
 .rpt2_cache/
 .rts2_cache_cjs/
@@ -69,9 +73,12 @@ web_modules/
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variables file
+# dotenv environment variable files
 .env
-.env.test
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
@@ -94,6 +101,12 @@ dist
 # vuepress build output
 .vuepress/dist
 
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
 # Serverless directories
 .serverless/
 
@@ -109,12 +122,43 @@ dist
 # Stores VSCode versions used for testing VSCode extensions
 .vscode-test
 
+### NextJS template
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+next-env.d.ts
+
+
 # yarn v3
-.pnp.*
 .yarn/*
+docs/.yarn/*
 !.yarn/patches
 !.yarn/plugins
 !.yarn/releases
+!docs/.yarn/releases
 !.yarn/sdks
 !.yarn/versions
 

docs/.eslintrc.yml

@@ -0,0 +1,14 @@
+env:
+  node: true
+  es2021: true
+extends:
+  - 'next/core-web-vitals'
+  - 'prettier'
+  - plugin:mdx/recommended
+plugins:
+  - '@typescript-eslint'
+rules:
+  'max-params': 'error'
+settings:
+  'mdx/code-blocks': true
+root: true

docs/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
+  "singleQuote": true,
+  "semi": true,
+  "trailingComma": "none",
+  "importOrder": ["^[./]"],
+  "importOrderParserPlugins": ["importAssertions", "typescript", "jsx"],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true
+}

docs/.yarnrc.yml

@@ -0,0 +1 @@
+yarnPath: .yarn/releases/yarn-3.4.1.cjs

docs/README.md

@@ -0,0 +1,34 @@
+# OreOreBot2 Documents
+
+新生はらちょドキュメントサイト
+
+## Getting Started
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/) v16.x or later
+- [Yarn](https://yarnpkg.com/) v3
+
+---
+
+1. このリポジトリをクローンします。
+   ([approvers](https://github.com/approvers) のメンバーではない場合は最初に Fork してください)
+
+   ```shell
+   git clone https://github.com/approvers/OreOreBot2.git
+   ```
+
+2. **OreOreBot2 Documents** の依存関係をインストールします。
+
+   **OreOreBot2** の依存関係とは全く無関係のため、注意してください。
+
+   ```shell
+   cd docs
+   yarn
+   ```
+
+3. 開発サーバーを起動します。
+
+   ```shell
+   yarn dev
+   ```

docs/next.config.js

@@ -0,0 +1,13 @@
+// @ts-checks
+
+const withNextra = require('nextra')({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.tsx'
+});
+
+module.exports = {
+  ...withNextra(),
+  images: {
+    unoptimized: true
+  }
+};

docs/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "haracho.approvers.dev",
+  "version": "1.0.0",
+  "main": "index.js",
+  "repository": "https://github.com/approvers/OreOreBot2",
+  "author": "approvers <[email protected]>",
+  "description": "新生はらちょドキュメントサイト",
+  "license": "MIT",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint",
+    "format": "prettier --ignore-path .gitignore -w **/*.{js,ts,jsx,tsx,md,mdx}"
+  },
+  "dependencies": {
+    "next": "^13.1.6",
+    "nextra": "^2.2.14",
+    "nextra-theme-docs": "^2.2.14",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^4.1.1",
+    "@types/node": "18.13.0",
+    "@types/react": "18.0.28",
+    "@typescript-eslint/eslint-plugin": "^5.51.0",
+    "@typescript-eslint/parser": "^5.51.0",
+    "eslint": "8.33.0",
+    "eslint-config-next": "13.1.6",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-mdx": "^2.0.5",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "prettier": "^2.8.4",
+    "typescript": "4.9.5"
+  },
+  "packageManager": "[email protected]"
+}

docs/src/atoms/badge.module.css

@@ -0,0 +1,6 @@
+.badge {
+  border: 1px;
+  border-radius: 0.4rem;
+  font-size: 75%;
+  padding: 0.25rem 0.5rem;
+}

docs/src/atoms/badge.tsx

@@ -0,0 +1,11 @@
+import type { ReactNode } from 'react';
+
+import style from './badge.module.css';
+
+export interface BadgeProps {
+  children: ReactNode;
+}
+
+export const Badge = ({ children }: BadgeProps): JSX.Element => {
+  return <span className={style.badge}>{children}</span>;
+};

docs/src/molecules/command-arg-list.module.css

@@ -0,0 +1,15 @@
+.args {
+  padding-left: 1rem;
+}
+
+.args > li {
+  list-style: disc;
+}
+
+.parameter {
+  padding-left: 2rem;
+}
+
+.parameter > li {
+  list-style: circle;
+}