|
| 1 | +<p align="center"> |
| 2 | +<img src="https://user-images.githubusercontent.com/22412567/171680920-6e74b77c-c565-487b-bff1-4f94976ecbe7.png" alt="Artalk" width="100%"> |
| 3 | +</p> |
| 4 | + |
| 5 | +# Artalk |
| 6 | + |
| 7 | +[](https://www.npmjs.com/package/artalk) |
| 8 | +[](https://www.npmjs.com/package/artalk) |
| 9 | +[](https://hub.docker.com/r/artalk/artalk-go) |
| 10 | +[](https://pkg.go.dev/github.com/artalkjs/artalk/v2) |
| 11 | +[](https://goreportcard.com/report/github.com/ArtalkJS/Artalk) |
| 12 | +[](https://circleci.com/gh/ArtalkJS/Artalk/tree/master) |
| 13 | +[](https://codecov.io/gh/ArtalkJS/Artalk) |
| 14 | +[](https://bundlephobia.com/package/artalk) |
| 15 | + |
| 16 | +[ホームページ](https://artalk.js.org) • [ドキュメント](https://artalk.js.org/en/guide/deploy.html) • [最新リリース](https://github.com/ArtalkJS/Artalk/releases) • [変更履歴](https://github.com/ArtalkJS/Artalk/blob/master/CHANGELOG.md) • [English](./README.md) • [简体中文](./README.zh.md) |
| 17 | + |
| 18 | +Artalk は直感的かつ高機能なコメントシステムで、あらゆるブログ、ウェブサイト、ウェブアプリケーションにすぐに導入できます。 |
| 19 | + |
| 20 | +- 🍃 クライアントは約 40KB、純粋な Vanilla JS で作られており、フレームワークに依存しません |
| 21 | +- 🍱 サーバーは Golang を採用し、効率的かつ軽量なクロスプラットフォーム性能を提供します |
| 22 | +- 🐳 Docker によるワンクリックデプロイで、手軽かつ高速に導入できます |
| 23 | +- 🌈 オープンソースソフトウェアで、プライバシーを最優先にセルフホストできます |
| 24 | + |
| 25 | +## 機能 |
| 26 | + |
| 27 | +<!-- prettier-ignore-start --> |
| 28 | + |
| 29 | +<!-- features --> |
| 30 | +* [サイドバー](https://artalk.js.org/guide/frontend/sidebar.html): 素早い管理と直感的な閲覧 |
| 31 | +* [ソーシャルログイン](https://artalk.js.org/guide/frontend/auth.html): ソーシャルアカウントによる高速ログイン |
| 32 | +* [メール通知](https://artalk.js.org/guide/backend/email.html): 多様な送信方法とメールテンプレート |
| 33 | +* [多様なプッシュ通知](https://artalk.js.org/guide/backend/admin_notify.html): 複数のプッシュ方法と通知テンプレート |
| 34 | +* [サイト内通知](https://artalk.js.org/guide/frontend/sidebar.html): 未読マークとメンション一覧 |
| 35 | +* [キャプチャ](https://artalk.js.org/guide/backend/captcha.html): 多様な認証タイプと頻度制限 |
| 36 | +* [コメントモデレーション](https://artalk.js.org/guide/backend/moderator.html): コンテンツ検出とスパム遮断 |
| 37 | +* [画像アップロード](https://artalk.js.org/guide/backend/img-upload.html): カスタムアップロード、画像ホスティング対応 |
| 38 | +* [Markdown](https://artalk.js.org/guide/intro.html): Markdown 構文に対応 |
| 39 | +* [絵文字パック](https://artalk.js.org/guide/frontend/emoticons.html): OwO 互換、簡単に統合 |
| 40 | +* [マルチサイト](https://artalk.js.org/guide/backend/multi-site.html): サイトの分離と一元管理 |
| 41 | +* [管理者](https://artalk.js.org/guide/backend/multi-site.html): パスワード認証とバッジ識別 |
| 42 | +* [ページ管理](https://artalk.js.org/guide/frontend/sidebar.html): 素早い閲覧とワンクリックでのタイトル遷移 |
| 43 | +* [ページビュー統計](https://artalk.js.org/guide/frontend/pv.html): ページビューを簡単に追跡 |
| 44 | +* [階層構造](https://artalk.js.org/guide/frontend/config.html#nestmax): ネストされたページネーション一覧と無限スクロール |
| 45 | +* [コメント投票](https://artalk.js.org/guide/frontend/config.html#vote): コメントの賛成・反対投票 |
| 46 | +* [コメント並び替え](https://artalk.js.org/guide/frontend/config.html#listsort): 多様な並び替えオプションを自由に選択 |
| 47 | +* [コメント検索](https://artalk.js.org/guide/frontend/sidebar.html): コメント内容を素早く検索 |
| 48 | +* [コメントのピン留め](https://artalk.js.org/guide/frontend/sidebar.html): 重要なメッセージをピン留め |
| 49 | +* [作成者のみ表示](https://artalk.js.org/guide/frontend/config.html): 作成者のコメントのみを表示 |
| 50 | +* [コメントジャンプ](https://artalk.js.org/guide/intro.html): 引用されたコメントへ素早く移動 |
| 51 | +* [自動保存](https://artalk.js.org/guide/frontend/config.html): 入力内容の消失を防止 |
| 52 | +* [IP 地域表示](https://artalk.js.org/guide/frontend/ip-region.html): ユーザーの IP 地域を表示 |
| 53 | +* [データ移行](https://artalk.js.org/guide/transfer.html): 自由な移行と素早いバックアップ |
| 54 | +* [画像ライトボックス](https://artalk.js.org/guide/frontend/lightbox.html): 画像ライトボックスを簡単に統合 |
| 55 | +* [画像の遅延読み込み](https://artalk.js.org/guide/frontend/img-lazy-load.html): 画像を遅延読み込みし、体験を最適化 |
| 56 | +* [LaTeX](https://artalk.js.org/guide/frontend/latex.html): LaTeX 数式の解析を統合 |
| 57 | +* [ナイトモード](https://artalk.js.org/guide/frontend/config.html#darkmode): ナイトモードへの切り替え |
| 58 | +* [拡張プラグイン](https://artalk.js.org/develop/plugin.html): さらなる可能性を創出 |
| 59 | +* [多言語対応](https://artalk.js.org/guide/frontend/i18n.html): 複数の言語を切り替え |
| 60 | +* [コマンドライン](https://artalk.js.org/guide/backend/config.html): コマンドラインによる操作管理 |
| 61 | +* [API ドキュメント](https://artalk.js.org/http-api.html): OpenAPI 形式のドキュメントを提供 |
| 62 | +* [プログラムのアップグレード](https://artalk.js.org/guide/backend/update.html): バージョンチェックとワンクリックアップグレード |
| 63 | +<!-- /features --> |
| 64 | + |
| 65 | +<!-- prettier-ignore-end --> |
| 66 | + |
| 67 | +## インストール |
| 68 | + |
| 69 | +Docker でワンステップで Artalk サーバーをデプロイ: |
| 70 | + |
| 71 | +```bash |
| 72 | +docker run -d \ |
| 73 | + --name artalk \ |
| 74 | + -p 8080:23366 \ |
| 75 | + -v $(pwd)/data:/data \ |
| 76 | + -e "TZ=America/New_York" \ |
| 77 | + -e "ATK_LOCALE=en" \ |
| 78 | + -e "ATK_SITE_DEFAULT=Artalk Blog" \ |
| 79 | + -e "ATK_SITE_URL=https://example.com" \ |
| 80 | + artalk/artalk-go |
| 81 | +``` |
| 82 | + |
| 83 | +Artalk クライアントをウェブページに組み込む: |
| 84 | + |
| 85 | +<!-- prettier-ignore-start --> |
| 86 | + |
| 87 | +```ts |
| 88 | +Artalk.init({ |
| 89 | + el: '#Comments', |
| 90 | + site: 'Artalk Blog', |
| 91 | + server: 'https://artalk.example.com', |
| 92 | + pageKey: '/2018/10/02/hello-world.html' |
| 93 | +}) |
| 94 | +``` |
| 95 | + |
| 96 | +<!-- prettier-ignore-end --> |
| 97 | + |
| 98 | +バイナリファイル、go install、Linux ディストリビューション向けのパッケージマネージャーなど、さまざまなインストール方法を提供しています。 |
| 99 | + |
| 100 | +[**詳しく見る →**](https://artalk.js.org/en/guide/deploy.html) |
| 101 | + |
| 102 | +## 開発者の方へ |
| 103 | + |
| 104 | +プルリクエストを歓迎します！ |
| 105 | + |
| 106 | +コードベースの扱い方、ローカル開発環境のセットアップ、変更の貢献については [開発](https://artalk.js.org/en/develop/) と [コントリビューション](./CONTRIBUTING.md) をご覧ください。 |
| 107 | + |
| 108 | +## コントリビューター |
| 109 | + |
| 110 | +皆さんの貢献はオープンソースコミュニティを豊かにし、学び、ひらめき、イノベーションを育みます。私たちは皆さんの参加を心から大切にしています。私たちのコミュニティに欠かせない存在でいてくれて、ありがとうございます！🥰 |
| 111 | + |
| 112 | +[](https://github.com/ArtalkJS/Artalk/graphs/contributors) |
| 113 | + |
| 114 | +## サポーター |
| 115 | + |
| 116 | +[](https://github.com/ArtalkJS/Artalk/stargazers) |
| 117 | + |
| 118 | +## Repobeats アナリティクス |
| 119 | + |
| 120 | + |
| 121 | + |
| 122 | +## Stargazer の推移 |
| 123 | + |
| 124 | +<a href="https://trendshift.io/repositories/6290" target="_blank"><img src="https://trendshift.io/api/badge/repositories/6290" alt="ArtalkJS%2FArtalk | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> |
| 125 | + |
| 126 | +[](https://starchart.cc/ArtalkJS/Artalk) |
| 127 | + |
| 128 | +## ライセンス |
| 129 | + |
| 130 | +[MIT](./LICENSE) |
| 131 | + |
| 132 | +[](https://app.fossa.com/projects/git%2Bgithub.com%2FArtalkJS%2FArtalk?ref=badge_shield) |
| 133 | + |
| 134 | +[](https://app.fossa.com/projects/git%2Bgithub.com%2FArtalkJS%2FArtalk?ref=badge_large) |
0 commit comments