このドキュメンテーションの編集方法
このドキュメンテーションは、以下の流れで組み上がっています。
- GitHubというサイトに、テキストファイルをアップロードする
- Cloudflare Pagesというサービスが、いい感じにこのサイトを作り上げてくれる
- Cloudflare Pagesで自動的に公開してくれる
このドキュメンテーションの編集をご希望の方は、このうち「手順1」のやり方だけ知っていればOKです。notionやスプレッドシートと比べるとわずかに難しいですが、慣れれば誰でも見やすく安全なドキュメントがすぐにできます。挑戦してみてください。
GitHubへの登録
このドキュメンテーションを編集するためには、GitHubというサイトへの登録が必要です。
日本語に対応していませんが、翻訳を使えば問題なく登録を先に進めることができます。
アカウントを作成したら、 組織（Organization） に皆さんを招待しますので、運営チームにお声がけください。
「Git」というツールと「GitHub」というサイト（サービス）は別物ですが、技術者でない方はこのことについて理解しておく必要はありません。
完成した連絡が来たら、こちらにアクセスしてください。
https://github.com/wowfull/wowfull-docs
技術者の方は、このリポジトリにアクセスしたときに見えるガイドに従い編集を行ってください。やむを得ない場合は下の手順で編集してもいいですが、極力避けるようにしてください。
このような画面になっています。中身の編集を行うには、docsをクリックします。
目的のファイルを発見したら、右上の鉛筆を押して編集してください。
編集が完了したら、Commit changes...を押します。
数分待機すると、文法にエラーがなければ勝手に更新が入っているはずです。
文法にエラーがある場合、修正するまで更新できなくなります。
テキストファイルの文法
このサイトのテキストファイルは、Markdownという文法を採用しています。Markdownを使用すると、
- 表の作成
- 太字・斜体などの装飾
をしながら、Wordやスプレッドシートと異なり、普通の文字ファイルとしても扱えるようになります。
Markdownを使わなくても記事の執筆は行えます。ちなみに、notionもMarkdownを採用しています。
詳細はこちらのサイトをご覧ください。
https://help.docbase.io/posts/13697
https://www.markdownguide.org/basic-syntax/
拡張文法
Docusaurus（このサイトを作っているエンジン）は、上記のMarkdownに加えて、いくつかの独自構文を持っています。詳しくは次のページで解説しています。
MDX（上級）
Docusaurusでは、MDXを使用することもできます。MDXは、Markdownの中でJSXを扱えるようにするものです。詳しくは次のページで解説しています。