Skip to content
Janko Marohnić edited this page Jul 18, 2014 · 25 revisions

Slate spits out a bunch of static HTML, Javascript, and CSS, so it's pretty trivial to host.

Publishing Your Docs to Github Pages

Publishing your API documentation couldn't be more simple.

  1. Commit your changes to the markdown source: git commit -a -m "Update index.md"
  2. Push the markdown source changes to Github: git push
  3. Add "gh-pages" as a local branch pointing to the remote (GitHub page)
  4. Compile to HTML, and push the HTML to Github pages: rake publish

Done! Your changes should now be live on http://yourusername.github.io/slate, and the main branch should be updated with your edited markdown. Note that if this is your first time publishing Slate, it can sometimes take ten minutes or so before your content is available online.

Publishing Your Docs to Your Own Server

Instead of using rake publish, use rake build. Middleman will build your website to the build directory of your project, and you can copy those static HTML files to the server of your choice.

Using Github CNAME

You can use a Github CNAME to host with a custom domain. Place the CNAME file in source folder and use rake publish like normal.