[API 정의서] Slate 사용하기

api 정의서를 slate로 사용하기로 결정한 이유는 마크다운 형식으로 index.html.md 파일안에서만 내용을 작성하면 되기 때문에 간편하다는 점과 기본적인 템플릿을 제공하기 때문에 내가 원하는 템플릿으로 손쉽게 바꿀 수 있다는 점 때문에 slate를 사용하여 api를 작성하게 되었습니다.

1. 설치하기

slate 깃헙 페이지
Windows 기준 설치법

1. ruby 설치
2. gem update --system
3. gem install bundler
4. git clone https://github.com/[github-name]/slate
5. cd slate
6. bundle install
7. bundle exec middleman server // 실행

2. 핫 리로딩 적용하기

slate는 기본적으로 핫 리로딩 기능이 포함되지 않기 때문에 핫 리로드 기능을 제공하는 라이브러리를 설치하여야 합니다. 라이브러리 버전은 설치시 업로드 된 버전에 맞게 설정해주시기 바랍니다.

livereload 깃헙 페이지
1. Gemfile => gem "middleman-livereload", "~> 3.4.4" 추가
2. config.rb => activate :livereload 추가

3. github pages 사용하여 배포

1. cd slate => bundle exec middleman build (빌드 파일 생성)
2. slate/build 파일을 호스팅 하려는 저장소에 옮깁니다.

bundle exec middleman server 실행 시 에러 슈팅

에러내용: Unable to load the EventMachine C extension; To use the pure-ruby reactor, require 'em/pure_ruby'

다음과 같은 에러가 발생할 경우 아래와 같이 수정하시면 정상 동작합니다.
1. gem uninstall eventmachine
2. ridk exec pacman -Sy openssl
3. gem install eventmachine --platform ruby
4. cd C:\Ruby26-x64\lib\ruby\gems\2.6.0\gems\eventmachine-1.2.7-x64-mingw32\lib
5. code.

6. 최상단 require 'em/pure_ruby' 추가