first commit

Author: cm-igarashi-ryosuke

.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.node-version

@@ -0,0 +1 @@
+18.12.0

README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ npm install
+```
+
+### Local Development
+
+```
+$ npm start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true npm run deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> npm run 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.

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/basics/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Basics",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "プロジェクトの全体像など、開発に必要な前提知識を提供します。"
+  }
+}

docs/basics/overview.md

@@ -0,0 +1,114 @@
+---
+sidebar_position: 1
+---
+
+# Overview
+
+このページではZennの全体像を知ってもらうため、Zennの各サービス、ツール、パッケージの概要とそれらの依存関係について説明します。
+
+## 依存関係グラフ
+
+Zennの各サービス、ツール、パッケージの依存関係グラフを以下に示します。
+
+- 実線: npmパッケージに依存
+- 破線: APIを呼び出すなど間接的に依存
+
+```mermaid
+flowchart TD
+    classDef Service stroke-width:4px;
+
+    zenn.dev:::Service
+    zenn-cli:::Service
+    zenn-vscode-extension:::Service
+    embed.zenn.studio:::Service
+    backend-api:::Service
+    api-markdown-html:::Service
+
+    zenn.dev-->zenn-embed-elements
+    zenn.dev-->zenn-content-css
+    zenn.dev-.http.->api-markdown-html
+    zenn.dev-.http.->embed.zenn.studio
+    zenn.dev-.http.->backend-api
+
+    zenn-cli-->zenn-markdown-html
+    zenn-cli-->zenn-content-css
+    zenn-cli-->zenn-validator
+    zenn-cli-->zenn-embed-elements
+    zenn-cli-.http.->embed.zenn.studio
+
+    zenn-vscode-extension-->zenn-markdown-html
+    zenn-vscode-extension-->zenn-content-css
+    zenn-vscode-extension-->zenn-validator
+    zenn-vscode-extension-->zenn-embed-elements
+    zenn-vscode-extension-.http.->embed.zenn.studio
+
+    backend-api-.http.->api-markdown-html
+
+    api-markdown-html-->zenn-markdown-html
+```
+
+## サービス
+
+### zenn.dev
+
+Zennのメインサービスです。Next.jsのプロジェクトです。
+
+リポジトリは非公開。
+
+### backend-api
+
+zenn.devのバックエンドサーバーです。Ruby on Railsのプロジェクトです。
+
+リポジトリは非公開。
+
+### embed.zenn.studio
+
+markdownの埋め込み要素を表示するためのiframeを返すサーバーです。Next.jsのプロジェクトです。
+
+リポジトリは非公開。
+
+### api-markdown-html
+
+markdownをZennで表示可能なHTMLに変換するAPIです。`zenn-markdown-html` をラップしたCloud Functions(Node.js)のプロジェクトです。
+
+リポジトリは非公開。
+
+## ツール
+
+### zenn-cli
+
+markdownをローカルで作成・プレビューするためのCLIとWebのツールです。JavaScript(TypeScript)とNode.jsのプロジェクトです。
+
+[GitHubリポジトリ](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-cli)
+
+### zenn-vscode-extension
+
+markdownをVSCode for the Web(github.devなど)で作成・プレビューするためのVSCode Web拡張機能です。JavaScript(TypeScript)のプロジェクトです。
+
+[GitHubリポジトリ](https://github.com/zenn-dev/zenn-vscode-extension)
+
+## パッケージ
+
+### zenn-content-css
+
+ZennのHTMLに適用するCSSを提供するパッケージです。
+
+[GitHubリポジトリ](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-content-css)
+
+### zenn-embed-elements
+
+markdownの埋め込み要素をクライアント側でHTMLに変換するパッケージです。
+
+[GitHubリポジトリ](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-embed-elements)
+
+### zenn-markdown-html
+
+markdownをZennで表示可能なHTMLに変換するパッケージです。
+
+[GitHubリポジトリ](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-markdown-html)
+
+### zenn-validator
+
+markdownの内容（frontmatterなどZennの仕様）を検証するパッケージです。
+
+[GitHubリポジトリ](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-validator)

docs/basics/repositories.md

@@ -0,0 +1,23 @@
+---
+sidebar_position: 2
+---
+
+# Repositories
+
+このページではZennのツール、パッケージのリポジトリについて説明します。
+
+現在、これらは [zenn-editor](#zenn-editor) と [zenn-vscode-extension](#zenn-vscode-extension) の 2つのリポジトリで管理されています。
+
+## zenn-editor
+
+以下のプロジェクトを含むモノレポとして管理されています。
+
+- [zenn-cli](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-cli)
+- [zenn-content-css](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-content-css)
+- [zenn-embed-elements](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-embed-elements)
+- [zenn-markdown-html](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-markdown-html)
+- [zenn-validator](https://github.com/zenn-dev/zenn-editor/tree/main/packages/zenn-validator)
+
+## zenn-vscode-extension
+
+[zenn-vscode-extension](https://github.com/zenn-dev/zenn-vscode-extension) 専用のリポジトリです。

docs/contribution.md

@@ -0,0 +1,29 @@
+---
+sidebar_position: 2
+---
+
+# Contribution
+
+ZennのOSSにコントリビュートする方法を説明します。
+
+## Issue を作成する
+
+Zennでは機能リクエストやバグのトラッキングに [zenn/zenn-community](https://github.com/zenn-dev/zenn-community) リポジトリの Issue を利用しています。
+
+あなたが機能リクエストやバグ報告をする場合は、どのツールやライブラリに対する内容であっても zenn/zenn-community リポジトリに Issue を作成してください。ただし、セキュリティに関する問題などパブリックにすることで問題が発生する可能性のあるものは、[Zennのお問い合わせフォーム](https://zenn.dev/inquiry)から連絡してください。
+
+### 機能リクエストの場合
+
+作成された Issue はZennの開発チームが内容を確認し、提案を受け入れるかどうかを判断します。開発チームがコンテキストを理解できるよう、Issue Templateに従いできるだけ詳しく内容を記載してください。
+
+大まかな受け入れの基準は、**Zennとしての方針に沿っていること**、**多くのユーザーにメリットがあること**、**持続してメンテナンスが可能であること**、**互換性が保たれること**、などです。（この他に、各ツール・ライブラリごとに細かい方針がある場合があります。）限定的なユースケースや環境に依存するリクエストは受け入れられない可能性が高いです。
+
+### 既存のIssueの解決を手伝う
+
+既存の Issue にコメントすることで Issue の解決を手伝うこともできます。技術的な問題解決の提案や、バグの再現情報の提供など、Issue を解決するために必要な情報を提供していただけるだけでも大変ありがたいです。
+
+## Pull Request を作成する
+
+Zennの開発チームが受け入れた Issue について、実装を行い Pull Request を作成することができます。Pull Request の受け入れ条件は、各ツール・ライブラリの開発ガイドを参照してください。
+
+その他、テストコードの追加、リファクタリング、ライブラリのアップデート、ドキュメントの修正、などの Pull Request も歓迎します。これらは Issue を作成する必要はありませんが、変更が大きい場合は受け入れられない可能性もありますので、心配な場合は Issue を作成してください。

docs/guides/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Guides",
+  "position": 4,
+  "link": {
+    "type": "generated-index"
+  }
+}