artalkjs/README.ja.md

Artalk

ホームページ • ドキュメント • 最新リリース • 変更履歴 • English • 简体中文

Artalk は直感的かつ高機能なコメントシステムで、あらゆるブログ、ウェブサイト、ウェブアプリケーションにすぐに導入できます。

• 🍃 クライアントは約 40KB、純粋な Vanilla JS で作られており、フレームワークに依存しません
• 🍱 サーバーは Golang を採用し、効率的かつ軽量なクロスプラットフォーム性能を提供します
• 🐳 Docker によるワンクリックデプロイで、手軽かつ高速に導入できます
• 🌈 オープンソースソフトウェアで、プライバシーを最優先にセルフホストできます

機能

• サイドバー: 素早い管理と直感的な閲覧
• ソーシャルログイン: ソーシャルアカウントによる高速ログイン
• メール通知: 多様な送信方法とメールテンプレート
• 多様なプッシュ通知: 複数のプッシュ方法と通知テンプレート
• サイト内通知: 未読マークとメンション一覧
• キャプチャ: 多様な認証タイプと頻度制限
• コメントモデレーション: コンテンツ検出とスパム遮断
• 画像アップロード: カスタムアップロード、画像ホスティング対応
• Markdown: Markdown 構文に対応
• 絵文字パック: OwO 互換、簡単に統合
• マルチサイト: サイトの分離と一元管理
• 管理者: パスワード認証とバッジ識別
• ページ管理: 素早い閲覧とワンクリックでのタイトル遷移
• ページビュー統計: ページビューを簡単に追跡
• 階層構造: ネストされたページネーション一覧と無限スクロール
• コメント投票: コメントの賛成・反対投票
• コメント並び替え: 多様な並び替えオプションを自由に選択
• コメント検索: コメント内容を素早く検索
• コメントのピン留め: 重要なメッセージをピン留め
• 作成者のみ表示: 作成者のコメントのみを表示
• コメントジャンプ: 引用されたコメントへ素早く移動
• 自動保存: 入力内容の消失を防止
• IP 地域表示: ユーザーの IP 地域を表示
• データ移行: 自由な移行と素早いバックアップ
• 画像ライトボックス: 画像ライトボックスを簡単に統合
• 画像の遅延読み込み: 画像を遅延読み込みし、体験を最適化
• LaTeX: LaTeX 数式の解析を統合
• ナイトモード: ナイトモードへの切り替え
• 拡張プラグイン: さらなる可能性を創出
• 多言語対応: 複数の言語を切り替え
• コマンドライン: コマンドラインによる操作管理
• API ドキュメント: OpenAPI 形式のドキュメントを提供
• プログラムのアップグレード: バージョンチェックとワンクリックアップグレード

インストール

Docker でワンステップで Artalk サーバーをデプロイ:

docker run -d \
    --name artalk \
    -p 8080:23366 \
    -v $(pwd)/data:/data \
    -e "TZ=America/New_York" \
    -e "ATK_LOCALE=en" \
    -e "ATK_SITE_DEFAULT=Artalk Blog" \
    -e "ATK_SITE_URL=https://example.com" \
    artalk/artalk-go

Artalk クライアントをウェブページに組み込む:

Artalk.init({
  el:      '#Comments',
  site:    'Artalk Blog',
  server:  'https://artalk.example.com',
  pageKey: '/2018/10/02/hello-world.html'
})

バイナリファイル、go install、Linux ディストリビューション向けのパッケージマネージャーなど、さまざまなインストール方法を提供しています。

詳しく見る →

開発者の方へ

プルリクエストを歓迎します！

コードベースの扱い方、ローカル開発環境のセットアップ、変更の貢献については 開発 と コントリビューション をご覧ください。

コントリビューター

皆さんの貢献はオープンソースコミュニティを豊かにし、学び、ひらめき、イノベーションを育みます。私たちは皆さんの参加を心から大切にしています。私たちのコミュニティに欠かせない存在でいてくれて、ありがとうございます！🥰

サポーター

Repobeats アナリティクス

Stargazer の推移

ライセンス

MIT