16
슬레이트-API에 대한 아름다운 정적 문서.기능 깨끗하고 직관적 인 디자인 — Slate를 사용하면 API에 대한 설명이 설명서의 왼쪽에 있고 모든 코드 예제는 오른쪽에 있습니다.Stripe과 Paypal의 API 문서에서 영감을 얻었습니다.슬레이트는 반응이 좋기 때문에 태블릿, 전화 및 인쇄물에서도 멋지게 보입니다.단일 페이지의 모든 것 — 사용자가 원하는 것을 찾기 위해 백만 페이지를 검색해야하는 시대는 지났습니다.슬레이트는 전체 문서를 한 페이지에 넣습니다.그러나 우리는 연결성을 희생하지 않았습니다.스크롤하면 브라우저의 해시가 가장 가까운 헤더로 업데이트되므로 설명서의 특정 지점에 연결하는 것이 여전히 자연스럽고 쉽습니다.Slate는 단순한 마크 다운 — Slate로 문서를 작성할 때 Markdown 만 작성하면 편집 및 이해가 간단 해집니다.코드 샘플조차도 마크 다운 코드 블록 일뿐입니다.여러 언어로 코드 샘플 작성 — API에 여러 프로그래밍 언어로 바인딩 된 경우 탭을 쉽게 삽입하여 서로 전환 할 수 있습니다.문서에서 Github Flavored Markdown과 같이 각 코드 블록 상단에 언어 이름을 지정하여 다른 언어를 구별 할 수 있습니다.거의 60 개 언어에 대한 기본 구문 강조 표시로 구성이 필요하지 않습니다.페이지의 가장 왼쪽에있는 자동으로 매끄럽게 스크롤되는 목차.스크롤하면 문서의 현재 위치가 표시됩니다.빠릅니다.TripIt에서 Slate를 사용하여 목차가 180 개가 넘는 새로운 API에 대한 문서를 작성하고 있습니다.더 큰 문서에서도 성능이 우수하게 유지되었습니다.
slate-api-docs-generator
카테고리
Microsoft Visual Studio 용 Slate API Docs Generator의 대안
1
Document! X
문서!X는 자동화 된 문서 도구와 완벽한 저작 환경의 조합으로 .NET, 웹 서비스, 데이터베이스, XSD, Java, Javascript에 대한 전문가 수준의 정확한 문서를 작성, 게시 및 유지 관리하는 데 사용할 수 있습니다.
0
