Skip to content

traPtitech/naro-text

Repository files navigation

naro-text

記法

https://vitepress.dev/guide/markdown

ファイル名

  • {index}_{name}.md
    • 例: 0_index.md
  • 画像
    • imagesディレクトリを切って配置
    • 画像の名前で何の画像かわかるようにしてください

記入の注意点

  • 内輪ネタは避けましょう
  • section 以下は基本フラットな構造を保って下さい
  • HackMD 独自記法をすべてカバーしているわけではないので注意しましょう
  • 節タイトルは内容を簡潔に表したものにしてください
    • その1,その2みたいなのは出来るだけ避ける
  • container(:::info など)は以下の方針を目安に利用してください
    • tip: 注釈(Git/CLI の操作法など)
    • info: 発展的な内容、コラム
    • warning: 注意事項(気をつけないと正常に実行できないことがあるもの)
    • danger: 破壊的な事象(サーバーに負荷を与える操作など)
    • 練習問題は heading で区切って、container は使用しない
      • 答えを載せる場合は details を使用して隠す

使用しているポート

用途 ポート番号
フロントエンド 5173
バックエンド 8080
Adminer 8081