Skip to content

Instantly share code, notes, and snippets.

@mizucoffee
Last active January 25, 2023 09:39
Show Gist options
  • Star 4 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save mizucoffee/e9323003db832b9aa53ebda1e41bf89b to your computer and use it in GitHub Desktop.
Save mizucoffee/e9323003db832b9aa53ebda1e41bf89b to your computer and use it in GitHub Desktop.
オタクはすぐにこういう事がしたくなる

かっこいいREADME.mdの書き方

なんかそれっぽいREADMEを書きましょう。

ちなみに、これ作るとめっちゃモチベ上がるんでおすすめです。
自分はある程度大きくなると予想されるプロジェクトは一番最初に作るようにしています。

1. 画像

画像は1500x600で作ります。センタリングして上にロゴ、下にプロジェクト名を配置します。 Yuntan-Logo

2. キャッチコピー

npmだとpackage.jsonのdescriptionが使えます。 <h2 align="center">なんかかっこいいキャッチコピー</h2> とします。

なんかかっこいいキャッチコピー

こんな感じになります。

3. バッジ

<p align="center">
  <!-- ここに配置します -->
</p>

但し、センタリングされたpの中にはmarkdownを書く事ができない為、HTMLのバッジにする必要があります。

<a alt="code style: prettier" href="https://github.com/prettier/prettier">
  <img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg">
</a>
<a alt="sus: v2.17.0" href="https://seaurchin.kb10uy.org/wiki/score/format">
  <img src="https://img.shields.io/badge/sus-v2.17.0-blue.svg">
</a>
<a alt="MIT License" href="https://kawakawaritsuki.mit-license.org/">
  <img src="https://img.shields.io/badge/license-MIT-blue.svg">
</a>

ギャラリー

Yuntan-Logo

The "Cut the Air" Game Simulator


Twiback-Logo

Twitter Backup Service


sus-analyzer-Logo

SeaUrchinScore Analyzer for node

Build Status Coverage Status code style: prettier Maintainability
Documents npm npm downloads sus:v2.17.0 MIT License


iori-logo

Music Review Service

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment