Skip to content

Commit

Permalink
Taking out preview instructions because they don't work
Browse files Browse the repository at this point in the history
  • Loading branch information
Greg Wilson committed Feb 23, 2016
1 parent bb542e2 commit d30cbb9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 23 deletions.
2 changes: 0 additions & 2 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@

Go ahead,
but you *must* have the variables described in [CUSTOMIZATION.md](CUSTOMIZATION.md).
Please make sure to run `tools/check.py` after adding or changing variables
to make sure that our main website will understand your changes.

* *What is the "Windows installer"?*

Expand Down
38 changes: 17 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,7 @@ please [get in touch](#getting-and-giving-help).
its GitHub Pages website is at `http://your_username.github.io/YYYY-MM-DD-site`.
4. When you are done editing,
you can preview your website.
Again,
you can view your website:
if your repository is `https://github.com/your_username/YYYY-MM-DD-site`,
its website will be `http://your_username.github.io/YYYY-MM-DD-site`.
Expand All @@ -116,27 +115,22 @@ The following steps are only necessary if you want to run the website locally on
## Checking Your Changes
**Note:** to check your changes you need some softwares
that are describe at [Installing Software session](#installing-software).
1. To check your changes on your desktop you need some softwares
described at [Installing Software session](#installing-software).
This may require some work to set up,
so feel free to preview by pushing to the website.
No matter how you edit `index.html`, you should:
2. For some links to work properly,
particularly the link to your workshop's Eventbrite registration page,
you must view `_site/index.html` using an HTTP server.
If you have Jekyll installed,
you can do this by running:
1. Check your changes by running `tools/check.py` at the command line
from the root directory of your repository.
2. Preview your changes by running `tools/preview` and looking at `_site/index.html`.
For some links to work properly,
particularly the link to your workshop's Eventbrite registration page,
you must view `_site/index.html` using an HTTP server.
If you have Jekyll installed,
you can do this by running:
~~~
$ jekyll server -d _site
~~~
~~~
$ jekyll server -d _site
~~~
and going to http://localhost:4000.
and going to http://localhost:4000.
## Installing Software
Expand Down Expand Up @@ -184,7 +178,9 @@ you must install the software described below.
the default Redcarpet, because Kramdown handles Markdown
inside HTML blocks.
Note: You may need to specify the version of gem to use for installation (if you have multiple versions of Ruby installed). For example for version 2.0 you could use:
Note: you may need to specify the version of gem to use for installation
if you have multiple versions of Ruby installed.
For example for version 2.0 you could use:
~~~
$ gem2.0 install github-pages
Expand Down

0 comments on commit d30cbb9

Please sign in to comment.