Merge pull request #989 from mojombo/docs-proofreading
Proofread and fix up the documentation
This commit is contained in:
commit
d2f364b60c
|
@ -207,7 +207,7 @@ before your site is served.
|
||||||
<tr class='setting'>
|
<tr class='setting'>
|
||||||
<td>
|
<td>
|
||||||
<p class='name'><strong>Base URL</strong></p>
|
<p class='name'><strong>Base URL</strong></p>
|
||||||
<p class='description'>Serve website with the given base URL</p>
|
<p class='description'>Serve the website from the given base URL</p>
|
||||||
</td>
|
</td>
|
||||||
<td class="align-center">
|
<td class="align-center">
|
||||||
<p><code class="option">baseurl: URL</code></p>
|
<p><code class="option">baseurl: URL</code></p>
|
||||||
|
|
|
@ -14,9 +14,9 @@ following in mind:
|
||||||
[RR](http://github.com/btakita/rr/tree/master).
|
[RR](http://github.com/btakita/rr/tree/master).
|
||||||
* If it's a brand new feature, make sure to create a new
|
* If it's a brand new feature, make sure to create a new
|
||||||
[Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps
|
[Cucumber](https://github.com/cucumber/cucumber/) feature and reuse steps
|
||||||
where appropriate. Also, whipping up some documentation in your fork's wiki
|
where appropriate. Also, whipping up some documentation in your fork's `site`
|
||||||
would be appreciated, and once merged it will be transferred over to the main
|
directory would be appreciated, and once merged it will also appear in
|
||||||
wiki.
|
the next update of the main site.
|
||||||
* If your contribution adds or changes any Jekyll behavior, make sure to update
|
* If your contribution adds or changes any Jekyll behavior, make sure to update
|
||||||
the documentation. It lives in `site/_posts`. If the docs are missing
|
the documentation. It lives in `site/_posts`. If the docs are missing
|
||||||
information, please feel free to add it in. Great docs make a great project!
|
information, please feel free to add it in. Great docs make a great project!
|
||||||
|
|
|
@ -41,8 +41,9 @@ $ pip install pygments
|
||||||
<p>
|
<p>
|
||||||
Homebrew doesn’t symlink the executables for you. For the Homebrew default
|
Homebrew doesn’t symlink the executables for you. For the Homebrew default
|
||||||
Cellar location and Python 2.7, be sure to add `/usr/local/share/python` to
|
Cellar location and Python 2.7, be sure to add `/usr/local/share/python` to
|
||||||
your `PATH`. For more information, check out [the Homebrew
|
your `PATH`. For more information, check out
|
||||||
wiki](https://github.com/mxcl/homebrew/wiki/Homebrew-and-Python).
|
<a href="https://github.com/mxcl/homebrew/wiki/Homebrew-and-Python">the
|
||||||
|
Homebrew wiki</a>.
|
||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
@ -35,7 +35,8 @@ relies on.
|
||||||
|
|
||||||
## Predefined Global Variables
|
## Predefined Global Variables
|
||||||
|
|
||||||
There are a number of predefined global variables that you can set in the front-matter of a page or post.
|
There are a number of predefined global variables that you can set in the
|
||||||
|
front-matter of a page or post.
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<thead>
|
<thead>
|
||||||
|
@ -53,7 +54,7 @@ There are a number of predefined global variables that you can set in the front-
|
||||||
<p>
|
<p>
|
||||||
|
|
||||||
If set, this specifies the layout file to use. Use the layout file
|
If set, this specifies the layout file to use. Use the layout file
|
||||||
name without file extension. Layout files must be placed in the
|
name without the file extension. Layout files must be placed in the
|
||||||
<code>_layouts</code> directory.
|
<code>_layouts</code> directory.
|
||||||
|
|
||||||
</p>
|
</p>
|
||||||
|
|
|
@ -4,11 +4,11 @@ title: Welcome
|
||||||
next_section: installation
|
next_section: installation
|
||||||
---
|
---
|
||||||
|
|
||||||
This site aims to be a comprehensive guide to Jekyll. We’ll cover everything
|
This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such
|
||||||
from getting your site up and running, creating and managing your content,
|
as getting your site up and running, creating and managing your content,
|
||||||
customizing the way your site works and looks, deploying to various
|
customizing the way your site works and looks, deploying to various
|
||||||
environments, as well as some advice on participating in the future development
|
environments, and give you some advice on participating in the future
|
||||||
of Jekyll itself.
|
development of Jekyll itself.
|
||||||
|
|
||||||
## So what is Jekyll, exactly?
|
## So what is Jekyll, exactly?
|
||||||
|
|
||||||
|
|
|
@ -8,7 +8,7 @@ next_section: usage
|
||||||
Getting Jekyll installed and ready-to-go should only take a few minutes. If it
|
Getting Jekyll installed and ready-to-go should only take a few minutes. If it
|
||||||
ever becomes a pain in the ass, please [file an
|
ever becomes a pain in the ass, please [file an
|
||||||
issue](https://github.com/mojombo/jekyll/issues/new) (or submit a pull request)
|
issue](https://github.com/mojombo/jekyll/issues/new) (or submit a pull request)
|
||||||
describing the issue you encountered, and how we might make the process easier.
|
describing the issue you encountered and how we might make the process easier.
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
|
@ -39,11 +39,11 @@ simply run the following command to install Jekyll:
|
||||||
$ gem install jekyll
|
$ gem install jekyll
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
All Jekyll’s gem dependencies are automatically installed by the above command,
|
All of Jekyll’s gem dependencies are automatically installed by the above
|
||||||
so you won’t have to worry about them at all. If you have problems installing
|
command, so you won’t have to worry about them at all. If you have problems
|
||||||
Jekyll, check out the [troubleshooting](../troubleshooting) page or [report an
|
installing Jekyll, check out the [troubleshooting](../troubleshooting) page or
|
||||||
issue](https://github.com/mojombo/jekyll/issues/new) so the Jekyll community can
|
[report an issue](https://github.com/mojombo/jekyll/issues/new) so the Jekyll
|
||||||
improve the experience for everyone.
|
community can improve the experience for everyone.
|
||||||
|
|
||||||
## Optional Extras
|
## Optional Extras
|
||||||
|
|
||||||
|
|
|
@ -7,9 +7,9 @@ next_section: templates
|
||||||
|
|
||||||
If you’re switching to Jekyll from another blogging system, Jekyll’s importers
|
If you’re switching to Jekyll from another blogging system, Jekyll’s importers
|
||||||
can help you with the move. Most methods listed on this page require read access
|
can help you with the move. Most methods listed on this page require read access
|
||||||
to the database to generate posts from your old system. Each method generates
|
to the database from your old system to generate posts for Jekyll. Each method
|
||||||
`.markdown` posts in the `_posts` directory based on the entries in the foreign
|
generates `.markdown` posts in the `_posts` directory based on the entries in
|
||||||
system.
|
the foreign system.
|
||||||
|
|
||||||
## Preparing for migrations
|
## Preparing for migrations
|
||||||
|
|
||||||
|
@ -72,7 +72,11 @@ $ ruby -rubygems -e 'require "jekyll/migrators/wordpress";
|
||||||
Jekyll::WordPress.process("database", "user", "pass")'
|
Jekyll::WordPress.process("database", "user", "pass")'
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
If you are using Webfaction and have to set up an [SSH tunnel](http://docs.webfaction.com/user-guide/databases.html?highlight=mysql#starting-an-ssh-tunnel-with-ssh), be sure to make the hostname (`127.0.0.1`) explicit, otherwise MySQL may block your access based on `localhost` and `127.0.0.1` not being equivalent in its authentication system:
|
If you are using Webfaction and have to set up an [SSH
|
||||||
|
tunnel](http://docs.webfaction.com/user-guide/databases.html?highlight=mysql#starting-an-ssh-tunnel-with-ssh),
|
||||||
|
be sure to make the hostname (`127.0.0.1`) explicit, otherwise MySQL may block
|
||||||
|
your access based on `localhost` and `127.0.0.1` not being equivalent in its
|
||||||
|
authentication system:
|
||||||
|
|
||||||
{% highlight bash %}
|
{% highlight bash %}
|
||||||
$ ruby -rubygems -e 'require "jekyll/migrators/wordpress";
|
$ ruby -rubygems -e 'require "jekyll/migrators/wordpress";
|
||||||
|
@ -81,15 +85,27 @@ $ ruby -rubygems -e 'require "jekyll/migrators/wordpress";
|
||||||
|
|
||||||
### Further Wordpress migration alternatives
|
### Further Wordpress migration alternatives
|
||||||
|
|
||||||
While the above methods work, they do not import much of the metadata that is usually stored in Wordpress posts and pages. If you need to export things like pages, tags, custom fields, image attachments and so on, the following resources might be useful to you:
|
While the above methods work, they do not import much of the metadata that is
|
||||||
|
usually stored in Wordpress posts and pages. If you need to export things like
|
||||||
|
pages, tags, custom fields, image attachments and so on, the following resources
|
||||||
|
might be useful to you:
|
||||||
|
|
||||||
- [Exitwp](https://github.com/thomasf/exitwp) is a configurable tool written in Python for migrating one or more Wordpress blogs into Jekyll (Markdown) format while keeping as much metadata as possible. Exitwp also downloads attachments and pages.
|
- [Exitwp](https://github.com/thomasf/exitwp) is a configurable tool written in
|
||||||
- [A great article](http://vitobotta.com/how-to-migrate-from-wordpress-to-jekyll/) with a step-by-step guide for migrating a Wordpress blog to Jekyll while keeping most of the structure and metadata.
|
Python for migrating one or more Wordpress blogs into Jekyll (Markdown) format
|
||||||
- [wpXml2Jekyll](https://github.com/theaob/wpXml2Jekyll) is an executable windows application for creating Markdown posts from your Wordpress XML file.
|
while keeping as much metadata as possible. Exitwp also downloads attachments
|
||||||
|
and pages.
|
||||||
|
- [A great
|
||||||
|
article](http://vitobotta.com/how-to-migrate-from-wordpress-to-jekyll/) with a
|
||||||
|
step-by-step guide for migrating a Wordpress blog to Jekyll while keeping most
|
||||||
|
of the structure and metadata.
|
||||||
|
- [wpXml2Jekyll](https://github.com/theaob/wpXml2Jekyll) is an executable
|
||||||
|
windows application for creating Markdown posts from your Wordpress XML file.
|
||||||
|
|
||||||
## Drupal
|
## Drupal
|
||||||
|
|
||||||
If you’re migrating from [Drupal](http://drupal.org), there is [a migrator](https://github.com/mojombo/jekyll/blob/master/lib/jekyll/migrators/drupal.rb) for you too:
|
If you’re migrating from [Drupal](http://drupal.org), there is [a
|
||||||
|
migrator](https://github.com/mojombo/jekyll/blob/master/lib/jekyll/migrators/drupal.rb)
|
||||||
|
for you too:
|
||||||
|
|
||||||
{% highlight bash %}
|
{% highlight bash %}
|
||||||
$ ruby -rubygems -e 'require "jekyll/migrators/drupal";
|
$ ruby -rubygems -e 'require "jekyll/migrators/drupal";
|
||||||
|
@ -98,7 +114,9 @@ $ ruby -rubygems -e 'require "jekyll/migrators/drupal";
|
||||||
|
|
||||||
<div class="note warning">
|
<div class="note warning">
|
||||||
<h5>Warning: Drupal Version Compatibility</h5>
|
<h5>Warning: Drupal Version Compatibility</h5>
|
||||||
<p>This migrator was written for Drupal 6.1 and may not work as expected on future versions of Drupal. Please update it and send us a pull request if necessary.</p>
|
<p>This migrator was written for Drupal 6.1 and may not work as expected with
|
||||||
|
newer versions of Drupal. Please update it and send us a pull request if
|
||||||
|
necessary.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Movable Type
|
## Movable Type
|
||||||
|
@ -119,7 +137,7 @@ $ ruby -rubygems -e 'require "jekyll/migrators/typo";
|
||||||
Jekyll::Typo.process("database", "user", "pass")'
|
Jekyll::Typo.process("database", "user", "pass")'
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
This code also has only been tested with Typo version 4+.
|
This code has only been tested with Typo version 4+.
|
||||||
|
|
||||||
## TextPattern
|
## TextPattern
|
||||||
|
|
||||||
|
@ -130,7 +148,12 @@ $ ruby -rubygems -e 'require "jekyll/migrators/textpattern";
|
||||||
Jekyll::TextPattern.process("database_name", "username", "password", "hostname")'
|
Jekyll::TextPattern.process("database_name", "username", "password", "hostname")'
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
You will need to run the above from the parent directory of your `_import` folder. For example, if `_import` is located in `/path/source/_import`, you will need to run this code from `/path/source`. The hostname defaults to `localhost`, all other variables are required. You may need to adjust the code used to filter entries. Left alone, it will attempt to pull all entries that are live or sticky.
|
You will need to run the above from the parent directory of your `_import`
|
||||||
|
folder. For example, if `_import` is located in `/path/source/_import`, you will
|
||||||
|
need to run this code from `/path/source`. The hostname defaults to `localhost`,
|
||||||
|
all other variables are required. You may need to adjust the code used to filter
|
||||||
|
entries. Left alone, it will attempt to pull all entries that are live or
|
||||||
|
sticky.
|
||||||
|
|
||||||
## Mephisto
|
## Mephisto
|
||||||
|
|
||||||
|
@ -150,11 +173,22 @@ $ ruby -rubygems -e 'require "jekyll/migrators/mephisto";
|
||||||
|
|
||||||
## Blogger (Blogspot)
|
## Blogger (Blogspot)
|
||||||
|
|
||||||
To import posts from Blogger, see [this post about migrating from Blogger to Jekyll](http://coolaj86.info/articles/migrate-from-blogger-to-jekyll.html). If that doesn’t work for you, you might want to try some of the following alternatives:
|
To import posts from Blogger, see [this post about migrating from Blogger to
|
||||||
|
Jekyll](http://coolaj86.info/articles/migrate-from-blogger-to-jekyll.html). If
|
||||||
|
that doesn’t work for you, you might want to try some of the following
|
||||||
|
alternatives:
|
||||||
|
|
||||||
- [@kennym](https://github.com/kennym) created a [little migration script](https://gist.github.com/1115810), because the solutions in the previous article didn't work out for him.
|
- [@kennym](https://github.com/kennym) created a [little migration
|
||||||
- [@ngauthier](https://github.com/ngauthier) created [another importer](https://gist.github.com/1506614) that imports comments, and does so via blogger’s archive instead of the RSS feed.
|
script](https://gist.github.com/1115810), because the solutions in the
|
||||||
- [@juniorz](https://github.com/juniorz) created [yet another importer](https://gist.github.com/1564581) that works for [Octopress](http://octopress.org). It is like [@ngauthier’s version](https://gist.github.com/1506614) but separates drafts from posts, as well as importing tags and permalinks.
|
previous article didn't work out for him.
|
||||||
|
- [@ngauthier](https://github.com/ngauthier) created [another
|
||||||
|
importer](https://gist.github.com/1506614) that imports comments, and does so
|
||||||
|
via blogger’s archive instead of the RSS feed.
|
||||||
|
- [@juniorz](https://github.com/juniorz) created [yet another
|
||||||
|
importer](https://gist.github.com/1564581) that works for
|
||||||
|
[Octopress](http://octopress.org). It is like [@ngauthier’s
|
||||||
|
version](https://gist.github.com/1506614) but separates drafts from posts, as
|
||||||
|
well as importing tags and permalinks.
|
||||||
|
|
||||||
## Posterous
|
## Posterous
|
||||||
|
|
||||||
|
@ -165,14 +199,17 @@ $ ruby -rubygems -e 'require "jekyll/migrators/posterous";
|
||||||
Jekyll::Posterous.process("my_email", "my_pass")'
|
Jekyll::Posterous.process("my_email", "my_pass")'
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
For any other Posterous blog on your account, you will need to specify the `blog_id` for the blog:
|
For any other Posterous blog on your account, you will need to specify the
|
||||||
|
`blog_id` for the blog:
|
||||||
|
|
||||||
{% highlight bash %}
|
{% highlight bash %}
|
||||||
$ ruby -rubygems -e 'require "jekyll/migrators/posterous";
|
$ ruby -rubygems -e 'require "jekyll/migrators/posterous";
|
||||||
Jekyll::Posterous.process("my_email", "my_pass", "blog_id")'
|
Jekyll::Posterous.process("my_email", "my_pass", "blog_id")'
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
There is also an [alternative Posterous migrator](https://github.com/pepijndevos/jekyll/blob/patch-1/lib/jekyll/migrators/posterous.rb) that maintains permalinks and attempts to import images too.
|
There is also an [alternative Posterous
|
||||||
|
migrator](https://github.com/pepijndevos/jekyll/blob/patch-1/lib/jekyll/migrators/posterous.rb)
|
||||||
|
that maintains permalinks and attempts to import images too.
|
||||||
|
|
||||||
## Tumblr
|
## Tumblr
|
||||||
|
|
||||||
|
@ -183,9 +220,12 @@ $ ruby -rubygems -e 'require "jekyll/migrators/tumblr";
|
||||||
Jekyll::Tumblr.process("http://www.your_blog_url.com", true)'
|
Jekyll::Tumblr.process("http://www.your_blog_url.com", true)'
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
There is also [a modified Tumblr migrator](https://github.com/stephenmcd/jekyll/blob/master/lib/jekyll/migrators/tumblr.rb) that exports posts as Markdown and preserves post tags.
|
There is also [a modified Tumblr
|
||||||
|
migrator](https://github.com/stephenmcd/jekyll/blob/master/lib/jekyll/migrators/tumblr.rb)
|
||||||
|
that exports posts as Markdown and preserves post tags.
|
||||||
|
|
||||||
The migrator above requires the `json` gem and Python's `html2text` to be installed as follows:
|
The migrator above requires the `json` gem and Python's `html2text` to be
|
||||||
|
installed as follows:
|
||||||
|
|
||||||
{% highlight bash %}
|
{% highlight bash %}
|
||||||
$ gem install json
|
$ gem install json
|
||||||
|
@ -201,4 +241,5 @@ $ ruby -rubygems -e 'require "jekyll/migrators/tumblr";
|
||||||
|
|
||||||
## Other Systems
|
## Other Systems
|
||||||
|
|
||||||
If you have a system that there isn’t currently a migrator for, you should consider writing one and sending us a pull request.
|
If you have a system for which there is currently no migrator, consider writing
|
||||||
|
one and sending us a pull request.
|
||||||
|
|
|
@ -35,8 +35,8 @@ There are two main ways of creating pages:
|
||||||
- Create a folder in the site's root for each page, and place an index.html file
|
- Create a folder in the site's root for each page, and place an index.html file
|
||||||
in each page folder.
|
in each page folder.
|
||||||
|
|
||||||
Both methods work fine (and can be used in conjunction with each other), with the
|
Both methods work fine (and can be used in conjunction with each other),
|
||||||
only real difference being the resulting URLs.
|
with the only real difference being the resulting URLs.
|
||||||
|
|
||||||
### Named HTML files
|
### Named HTML files
|
||||||
|
|
||||||
|
|
|
@ -105,7 +105,10 @@ attributes:
|
||||||
|
|
||||||
<div class="note info">
|
<div class="note info">
|
||||||
<h5>Pagination does not support tags or categories</h5>
|
<h5>Pagination does not support tags or categories</h5>
|
||||||
<p>Pagination pages through every post in the <code>posts</code> variable regardless of variables defined in the YAML Front Matter of each. It does not currently allow paging over groups of posts linked by a common tag or category.</p>
|
<p>Pagination pages through every post in the <code>posts</code>
|
||||||
|
variable regardless of variables defined in the YAML Front Matter of
|
||||||
|
each. It does not currently allow paging over groups of posts linked
|
||||||
|
by a common tag or category.</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Render the paginated Posts
|
## Render the paginated Posts
|
||||||
|
|
|
@ -9,7 +9,7 @@ Jekyll is, at its core, a text transformation engine. The concept behind the
|
||||||
system is this: you give it text written in your favorite markup language, be
|
system is this: you give it text written in your favorite markup language, be
|
||||||
that Markdown, Textile, or just plain HTML, and it churns that through a layout
|
that Markdown, Textile, or just plain HTML, and it churns that through a layout
|
||||||
or series of layout files. Throughout that process you can tweak how you want
|
or series of layout files. Throughout that process you can tweak how you want
|
||||||
the site URLs to look, what data gets displayed in the layout and more. This is
|
the site URLs to look, what data gets displayed in the layout, and more. This is
|
||||||
all done through editing text files, and the static web site is the final
|
all done through editing text files, and the static web site is the final
|
||||||
product.
|
product.
|
||||||
|
|
||||||
|
|
|
@ -20,7 +20,7 @@ $ jekyll build --source <source> --destination <destination>
|
||||||
|
|
||||||
$ jekyll build --watch
|
$ jekyll build --watch
|
||||||
# => The current folder will be generated into ./_site,
|
# => The current folder will be generated into ./_site,
|
||||||
# and watch for changes and regenerate automatically.
|
# watched for changes, and regenerated automatically.
|
||||||
{% endhighlight %}
|
{% endhighlight %}
|
||||||
|
|
||||||
Jekyll also comes with a built-in development server that will allow you to
|
Jekyll also comes with a built-in development server that will allow you to
|
||||||
|
|
Loading…
Reference in New Issue