From 7ad88eaaf3e9c127055daebe23b11f10c4acf616 Mon Sep 17 00:00:00 2001 From: XhmikosR Date: Mon, 13 Oct 2014 13:23:58 +0300 Subject: [PATCH] Switch to Rouge for highlighting. --- .travis.yml | 3 +-- README.md | 11 ++++++----- _config.yml | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.travis.yml b/.travis.yml index 0eb45f6..175334e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,9 +6,8 @@ before_install: install: - travis_retry npm install -g grunt-cli - travis_retry npm install - - travis_retry gem install --no-document "jekyll:~>2.4.0" "sass:~>3.4.0" + - travis_retry gem install --no-document "jekyll:~>2.4.0" "rouge:~>1.7.2" "sass:~>3.4.0" matrix: fast_finish: true notifications: slack: heybb:51atQXKR2rpnbohAZ0X1vNbE - diff --git a/README.md b/README.md index c3261bc..1bacdcd 100644 --- a/README.md +++ b/README.md @@ -52,10 +52,11 @@ Ratchet's documentation is built with [Jekyll](http://jekyllrb.com) and publicly ### Running documentation locally -1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation). - - **Windows users:** Read [this unofficial guide](https://github.com/juthilo/run-jekyll-on-windows/) to get Jekyll up and running without problems. We use Pygments for syntax highlighting, so make sure to read the sections on installing Python and Pygments. -2. From the root `/ratchet/docs` directory, run `jekyll serve` in the command line. -3. Open in your browser, and boom! +1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v2.4.x). + - **Windows users:** Read [this unofficial guide](http://jekyll-windows.juthilo.com/) to get Jekyll up and running without problems. +2. Install the Ruby-based syntax highlighter, [Rouge](https://github.com/jneen/rouge), with `gem install rouge`. +3. From the root `/ratchet/docs` directory, run `jekyll serve` in the command line. +4. Open in your browser, and boom! Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/). @@ -82,7 +83,7 @@ A small list of "gotchas" is provided below for designers and developers startin - Use a JavaScript library like fingerblast.js to emulate touch events (ideally only loaded from desktop devices) - Script tags containing JavaScript will not be executed on pages that are loaded with push.js. If you would like to attach event handlers to elements on other pages, document-level event delegation is a common solution. - Ratchet uses XHR requests to fetch additional pages inside the application. Due to security concerns, modern browsers prevent XHR requests when opening files locally (aka using the file:// protocol); consequently, Ratchet does not work when opened directly as a file. - - A common solution to this is to simply serve the files from a local server. One convenient way to achieve this is to run ```python -m SimpleHTTPServer ``` to serve up the files in the current directory to ```http://localhost:``` + - A common solution to this is to simply serve the files from a local server. One convenient way to achieve this is to run `python -m SimpleHTTPServer ` to serve up the files in the current directory to `http://localhost:` ## Versioning diff --git a/_config.yml b/_config.yml index 6933456..5d9972b 100644 --- a/_config.yml +++ b/_config.yml @@ -4,7 +4,7 @@ authors: Connor Sears description: Build mobile apps with simple HTML, CSS, and JS components. # Dependencies -highlighter: pygments +highlighter: rouge # Permalinks permalink: pretty