search
LoginSignup
5

More than 3 years have passed since last update.

Organization

readme-md-generatorを使ってリッチなREADME.mdをお手軽に作ってみませんか?

今回は簡単にREADME.mdを作成できる、readme-md-generatorを紹介させていただきます。

githubはこちらです。良いと思った方は:star2:をつけると良いと思います。

readme-md-generatorとは

CLIで動かせる、美しいREADME.mdを生成するためのライブラリです。

package.jsonとgitの設定をデフォルトとしてREADME.mdを作成するようです。

使ってみました

基本的な使い方

このように対話式にREADME.mdの内容を設定できます

※↓のは全部Enterとしてるので、デフォルト値がそのままREADME.mdに書き込まれます。(または、npx readme-md-generator -yとしてもと全てデフォルト値としてくれます。)

Jx0YgBCnfG.gif

自動でmarkdownファイルが出来上がりました。

Screen Shot 2019-06-30 at 20.00.57.png


良いpackage.jsonの例としてはこのような感じになるようです。

※ちょっと前にこちらの投稿で書いたコードのpackage.jsonを再作成してみました。
https://qiita.com/okumurakengo/items/aecd060ce64c99a646c8

package.json
{
  "name": "react-hooks-todos",
  "version": "1.0.0",
  "description": "ReactのHooksを使ってReduxのTodoリストをReduxなしに書き換えたサンプル(TypeScript使用)",
  "main": "webpack.config.js",
  "scripts": {
    "start": "webpack-dev-server"
  },
  "homepage": "https://github.com/okumurakengo/react-hooks-todos#readme",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/okumurakengo/react-hooks-todos.git"
  },
  "author": "okumurakengo",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/okumurakengo/react-hooks-todos/issues"
  },
  "engines": {
    "npm": ">=5.5.0",
    "node": ">=9.3.0"
  }
}
bash
npx readme-md-generator -y

少し書き換えたりとかしましたが、こんな感じにREADME.md生成してくれました、すごいですね:grinning:
ライブラリの信用度も上がりそうです。

github.com_okumurakengo_react-hooks-todos (1).png

ejsのテンプレートを使用できる

npx readme-md-generator -p path/to/my/own/template.md

.mdファイルにejsで記述し、それをテンプレートとして使うことができます。

テンプレートの例はこちら:https://github.com/kefranabg/readme-md-generator/tree/master/templates


読んでいただいてありがとうございました。m(_ _)m

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
What you can do with signing up
5