旧ブログ

sambaiz.net に引っ越しました

CarteでAPIドキュメントを作る流れ

Carteとは

github.com

サンプル

準備

  • Jekyllのインストール
gem install jekyll
  • Carteをclone
git clone https://github.com/devo-ps/carte.git
  • サーバーを起動
cd carte
jekyll serve

http://127.0.0.1:4000/

編集

タイトル

  • _config.ymlのtitleを変更する
---
exclude: ['README.markdown']
permalink: ':title'
pygments: true
safe: false
title: 'Hoge API'

API

  • _postsに追加していく
  • titleは必須。その他は任意
---
category: Stuff
path: '/stuff/:id'
title: 'Delete a thing'
type: 'DELETE'

layout: nil
---

# 以下Markdown

Github Pagesで公開

JekyllベースなのでGithub Pagesで公開できます。

rm -rf .git
git init
git add .
git commit -m "sample"
git remote add origin <repo url>
git branch gh-pages
git push origin gh-pages

http://<user name>.github.io/<repo name>