Skip to content
This repository was archived by the owner on Jan 11, 2023. It is now read-only.

oreillymedia/atlas-bootstrap-basic

Repository files navigation

Basic Bootstrap Theme

This project shows how to create a basic Bootstrap theme for Atlas.

Local Development

This theme has a simple sinatra app so that you can develop and test your theme locally, which is wayyyy better than continually pushing the theme to Atlas for builds. It uses Rack::Directory to serve static files from the theme directory, and them mounts the test app as the root ("/"). To start the app, you'll need Ruby 1.9.3 and Bundler.) Once you have these installed, do this:

$ cd bootstrap-basic
$ bundle install
$ shotgun

You can then view the static site at localhost:9393. The cool thing is that this will update as you make changes to the file so that you can see the results in real time.

There is sample content in the sample-content.html and a sample TOC in sample-toc.html.

Including this theme in your project

The first step in including this theme in your project is pretty simple:

  • Clone this repo in the root directory of your project

Publishing your project on github pages

For now, the simplest way to publish a project is to do it as a static site on github pages. Here's what you need to do:

  • Create a new repo on GitHub where you plan to publish the site
  • Add a remote in your local atlas repo to your new github repo
  • switch to the "gh-pages" branch in your project
  • use the atlas gem to build the project
  • add and commit the new files
  • Push your gh-pages branch to your the gh-pages branch on github

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published