講義資料の構築の仕方 ​

giteaのフォーク ​

giteaをフォークしてください。

資料を作成する ​

mdファイルをdocs/text/以下に適宜フォルダわけして収容してください。 この際に、フォルダ名、ファイル名の名前順で並び替えられるので、注意してください。 また、mdファイル中に#でh1要素があると、その要素が目次に追加されます。それがない時のみ、ファイル名が目次に追加されます。

topページとUIの設定 ​

docs/index.mdを編集して、トップページをいじることができます。 具体的な書き方については、docs/index.md中のコメントを参考にして欲しいです。 UIについてはdocs/.vitepress/config.tsを編集してください。

配信 ​

Neoshowcaseなどで配信してください。 serverファイルについてもshowcaseで起動するとOGP(リンクカードの画像とかタイトルとか)がきちんと表示されるようになります。 それぞれの設定はここを参考にしてください。

よくわからない場合はwikiを参考にアプリを起動したのち、設定をコピペしてください。

ローカルでのプレビューについて ​

vitepressでやってます。うまいこと環境構築できる人は使ってください。

build設定をshowcaseのみにしているので、ローカルでbuild,previewしてもOGPは表示されません。(ゴメンネ!!)