[컴] slate 사용해서 api 문서 생성하기

 slate 슬레이트 / api doc generator /

slate 사용해서 api 문서 생성하기

여기서는 docker 를 이용해서 slate format 으로 만들어진 문서를 build 하고, static page 를 만드는 작업을 이야기한다.

• Using Slate in Docker · slatedocs/slate Wiki · GitHub

https://github.com/slatedocs/slate/releases/tag/v2.11.0 에서 src 를 download 하고, 압축을 풀자. 그 path 를 `D:/a/prog/ruby/slate/ 이라 하자.

docker pull slatedocs/slate
cd D:/a/prog/ruby/slate/docker run --rm --name slate -p 4567:4567 -v D:/a/prog/ruby/slate/source:/srv/slate/source -v D:/a/prog/ruby/slate/build:/srv/slate/build slatedocs/slate serve

docker run 설명

• 참고할 만한 문서: Use bind mounts | Docker Documentation

• ENTRYPOINT ["/srv/slate/slate.sh"] 이기에 결국 image 안에서 아래 command 를 실행하는 것과 같다.

/srv/slate/slate.sh serve

• slagedocs/slate 는 image name 이다.
• -v D:/a/prog/ruby/slate/source:/srv/slate/source : D:/a/prog/ruby/slate/source 를 /srv/slate/source 에 mount 하는 것이다.
• -v D:/a/prog/ruby/slate/build:/srv/slate/build : build folder 는 추후에 static page 를 build 하면 결과가 /src/slage/build directory 에 저장된다. 그래서 build 를 한 결과를 container 외부로 가져오기 위해 mount 해 놓는다. 그렇지 않으면 결과물이 docker image 안에 저장된다.

접속 Urls

• http://localhost:4567/ : local 의 slate 를 접속할 수 있다.
• http://localhost:4567/__middleman : local slate 의 configuration 을 확인할 수 있다.

build for static pages

D:/a/prog/ruby/slate/souce/ 를 가지고 static page 를 만들어준다.

docker exec -ti <container_id> bundle exec middleman build --clean