Decided
178k views178k
CommentsJekyll vs Slate
Overview
Share your Stack
Help developers discover the tools you use. Get visibility for your team's tech choices and contribute to the community's knowledge.
CLI (Node.js)
Manual
Advice on Jekyll, Slate
Detailed Comparison
Think of Jekyll as a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind GitHub Pages, which you can use to host sites right from your GitHub repositories. | Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your API. |
Simple - No more databases, comment moderation, or pesky updates to install—just your content.;Static - Markdown (or Textile), Liquid, HTML & CSS go in. Static sites come out ready for deployment.;Blog-aware - Permalinks, categories, pages, posts, and custom layouts are all first-class citizens here. | Clean, intuitive design — with Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by Stripe's and Paypal's API docs. Slate is responsive, so it looks great on tablets, phones, and even print.;Everything on a single page — gone are the days where your users had to search through a million pages to find what they wanted. Slate puts the entire documentation on a single page. We haven't sacrificed linkability, though. As you scroll, your browser's hash will update to the nearest header, so linking to a particular point in the documentation is still natural and easy.;Slate is just Markdown — when you write docs with Slate, you're just writing Markdown, which makes it simple to edit and understand. Everything is written in Markdown — even the code samples are just Markdown code blocks!;Write code samples in multiple languages — if your API has bindings in multiple programming languages, you easily put in tabs to switch between them. In your document, you'll distinguish different languages by specifying the language name at the top of each code block, just like with Github Flavored Markdown!;Out-of-the-box syntax highlighting for almost 60 languages, no configuration required.;Automatic, smoothly scrolling table of contents on the far left of the page. As you scroll, it displays your current position in the document. It's fast, too. We're using Slate at TripIt to build documentation for our new API, where our table of contents has over 180 entries. We've made sure that the performance remains excellent, even for larger documents.;Let your users update your documentation for you — by default, your Slate-generated documentation is hosted in a public Github repository. Not only does this mean you get free hosting for your docs with Github Pages, but it also makes it's simple for other developers to make pull requests to your docs if they find typos or other problems. Of course, if you don't want to, you're welcome to not use Github and host your docs elsewhere! |
Statistics | |
GitHub Stars 51.0K | GitHub Stars - |
GitHub Forks 10.2K | GitHub Forks - |
Stacks 2.0K | Stacks 101 |
Followers 1.4K | Followers 130 |
Votes 230 | Votes 8 |
Pros & Cons | |
Pros
Cons
| Pros
|
What are some alternatives to Jekyll, Slate?
Postman
It is the only complete API development environment, used by nearly five million developers and more than 100,000 companies worldwide.
Swagger UI
Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation and sandbox from a Swagger-compliant API
Hugo
Hugo is a static site generator written in Go. It is optimized for speed, easy use and configurability. Hugo takes a directory with content and templates and renders them into a full html website. Hugo makes use of markdown files with front matter for meta data.
Gatsby
Gatsby lets you build blazing fast sites with your data, whatever the source. Liberate your sites from legacy CMSs and fly into the future.
Apiary
It takes more than a simple HTML page to thrill your API users. The right tools take weeks of development. Weeks that apiary.io saves.
Hexo
Hexo is a fast, simple and powerful blog framework. It parses your posts with Markdown or other render engine and generates static files with the beautiful theme. All of these just take seconds.
ReadMe.io
It is an easy-to-use tool to help you build out documentation! Each documentation site that you publish is a project where there is space for documentation, interactive API reference guides, a changelog, and much more.
Middleman
Middleman is a command-line tool for creating static websites using all the shortcuts and tools of the modern web development environment.
Gridsome
Build websites using latest web tech tools that developers love - Vue.js, GraphQL and Webpack. Get hot-reloading and all the power of Node.js. Gridsome makes building websites fun again.
Docusaurus
Docusaurus is a project for easily building, deploying, and maintaining open source project websites.
