-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: haracho.approver.dev の monorepo 化 (#933)
- Loading branch information
Sho Sakuma
authored
Aug 4, 2023
1 parent
734a50b
commit 555cf37
Showing
98 changed files
with
10,756 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
paths: | ||
- src | ||
- docs | ||
paths-ignore: | ||
- '**/*.md' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,8 @@ | ||
C-GitHub Actions: | ||
- .github/workflows/*.yml | ||
|
||
T-OreOreBot2: | ||
- src/** | ||
|
||
T-Documents: | ||
- docs/** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
} |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
yarnPath: .yarn/releases/yarn-3.4.1.cjs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
// @ts-checks | ||
|
||
const withNextra = require('nextra')({ | ||
theme: 'nextra-theme-docs', | ||
themeConfig: './theme.config.tsx' | ||
}); | ||
|
||
module.exports = { | ||
...withNextra(), | ||
images: { | ||
unoptimized: true | ||
} | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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]" | ||
} |
Empty file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
.badge { | ||
border: 1px; | ||
border-radius: 0.4rem; | ||
font-size: 75%; | ||
padding: 0.25rem 0.5rem; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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>; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
.args { | ||
padding-left: 1rem; | ||
} | ||
|
||
.args > li { | ||
list-style: disc; | ||
} | ||
|
||
.parameter { | ||
padding-left: 2rem; | ||
} | ||
|
||
.parameter > li { | ||
list-style: circle; | ||
} |
Oops, something went wrong.