Skip to content

yomogyhub/yomogy_main

Repository files navigation

ようこそ Yomogy へ

こちらは、Synbio(合成生物学)や iGEM に関する情報を集約し、発信する場所です。オープンな議論や記事の作成を心から歓迎します。

(このコードを手元で動かしたい方はこちらからご確認ください。)

基本操作

  • 記事の投稿: post/blog 配下の適切な位置に mdx ファイルを配置することで、ブログ記事が公開されます。

手順

  1. ファイル名の注意: すべてのファイル名は、/^[a-zA-Z0-9\-]+$/ ( Alphabet, 数字, - (ハイフン) ) のみ受け付けます。また、下記の仕様に適さない場合、自動的に削除されます。
  2. Github アカウント作成: まず、Github のアカウントを作成してください。その後、コミュニティメンバーとしての申請を行ってください。承認後に記事の投稿などが可能となります。申請フォームはこちら
  3. 著者情報の登録: post/all-author.jsonに従って、自身の著者情報を追加または修正してください。必要に応じて、public/author/{任意}.pngに 200px × 200px の画像を配置してください。
  4. 記事の作成: blog-templateからテンプレートをダウンロードし、指示に従って記事を作成してください。(タイトルではなく) ファイル名が、URL になりますので、命名規則に気をつけて作成してください。
  5. 記事の投稿: 作成した記事はdevブランチのpost/blog/{ユーザー名}配下に追加してください。フォルダが存在しない場合は、post/blog/{ユーザー名}post/blog/{ユーザー名}/imagesを各自で作成してください。
  6. 画像の追加: post/blog/{ユーザー名}/images配下に、"png" "jpg" "jpeg" "gif"の 4 つの形式かつ 3MB 以下で配置することで使用できます。
  7. トップ画像の変更: トップ画像はdevブランチからstagingブランチへの Pull request を作成するたびに、自動的に更新されます。もし、トップ画像の変更が必要であれば、post/blog/{ユーザー名}/imagesに 1200px × 630px の画像を配置してください。

Deploy

ブランチについて

  • main: 本番環境
  • staging: 本番直前のテスト環境(基本的には確認後にmainにマージする)
  • dev: 開発環境
  • その他、devを基にしたブランチ: 各プロジェクトごとにブランチを作成

ブランチの状態はこちらから確認できます。

ルール

  1. 更新の流れ: devstagingmainという順序で更新を行います。
  2. Pull request の承認: mainstagingへの Pull request は、運営メンバーのみが承認することができます。

GitHub Actions

  • Dev ブランチの更新: devブランチへの push の際に、記事の確認を自動で行います。
  • staging ブランチの更新: devブランチからstagingブランチへの Pull request の際に、記事の更新を行います。
  • main ブランチのマージ: mainブランチへの Pull request が承認されたら、その内容を自動的にdevブランチにマージします。

より詳しいルールや設定に関しては、こちらをご参照ください。

LICENSE

  • このリポジトリのコード部分は、MIT LICENSEの下でライセンスされています。
  • このリポジトリの記事部分は、CC BY 4.0の下でライセンスされています。

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published