# ドキュメントの改善
Handlebarsはオープンソースプロジェクトです。ドキュメントを最新の状態に保つための「ドキュメント部門」はありません。このドキュメントサイトが有益で役立つサイトであるためには、あなたの協力が必要です。
リリースノート (新しいウィンドウで開きます)
'docs-needed'ラベルの付いたIssue (新しいウィンドウで開きます)
旧Handlebarsウェブサイト (新しいウィンドウで開きます)
以下のセクションは、ドキュメントの改善にご協力いただくために役立つはずです。
# どのように貢献を提出すればよいですか?
このサイトはGithub (新しいウィンドウで開きます)でホストされており、VuePress (新しいウィンドウで開きます)でレンダリングされています。
- ページに表示したい変更については、プルリクエスト (新しいウィンドウで開きます)を作成してください。
- 変更が1ページの内容のみに影響する場合は、このページの下部にある
このページへの変更を提案!
リンクをクリックするだけで済みます(詳細については別のユーザーのリポジトリでファイルを編集する (新しいウィンドウで開きます)を参照してください)。 - より複雑な変更(スタイリング、複数ページ、新しいページ、ビルド問題の修正)については、リポジトリをフォークする (新しいウィンドウで開きます)し、完了したらプルリクエストを提出してください。リポジトリ内のCONTRIBUTING.mdページ (新しいウィンドウで開きます)には、詳細情報が記載されています。この方法では、開発サーバーを使用し、変更を送信する前にプレビューすることができます。
# どのようにコンテンツを書けばよいですか?
ドキュメントはMarkdownで記述され、VuePress (新しいウィンドウで開きます)でレンダリングされます。VuePressは、markdownをレンダリングするためにmarkdown-it
パッケージを使用します。markdown-it
はCommonMark方言を実装しています。
これは、次のソースで説明されている構文を使用できることを意味します
- CommonMarkヘルプ (新しいウィンドウで開きます)
- markdown-itによって追加された構文拡張機能 (新しいウィンドウで開きます)
- VuePressによって追加された構文拡張機能 (新しいウィンドウで開きます)
これらの拡張機能に加えて、このサイトには、ソースファイルに埋め込むことができるカスタムVueコンポーネントがいくつか追加されています。
# どのように振る舞うべきですか?
危険
知的財産を尊重してください:ご自身で作成した場合、またはhandlebarsjs.com (新しいウィンドウで開きます)からコピーした場合にのみ、テキストやその他のメディアを送信してください。Handlebarsに関するブログ記事はたくさんありますが、これらの投稿のテキストは、著者の知的財産です。
ライセンス:コンテンツを送信すると、このサイトのライセンスに基づいてこのサイトで公開されることに同意したことになります。
行動規範:他の人に敬意を払い、性的な言葉遣いや下品な言葉遣いを避けてください。
# 何に貢献できますか?
- docs-needed (新しいウィンドウで開きます)とラベル付けされたIssueをhandlebars.js (新しいウィンドウで開きます)リポジトリで探してください。 それらは、ドキュメント化する必要がある何かを説明するIssueです。
- 新しいコンテンツを提案して送信してください。提案について不明な点がある場合は、プルリクエストを送信する前にIssueを作成できます。これにより、時間の無駄を省ける場合があります。
- 既存のコンテンツを改善してください。ナビゲーションの変更、タイプミスの修正、言語の改善、誤ったコンテンツの修正を提案できます。
- CSSスタイリングの問題を修正してください。このページのスタイリングは完璧には程遠いものです。改善したい場合は、ぜひ進めてください。大きな変更については、Issueを開いてお問い合わせください。