-
Notifications
You must be signed in to change notification settings - Fork 314
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README for Jekyll 2.0. [ci skip]
- Loading branch information
Showing
1 changed file
with
24 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,32 @@ | ||
jekyll-import | ||
============= | ||
# jekyll-import | ||
|
||
[![Build Status](https://travis-ci.org/jekyll/jekyll-import.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-import) | ||
|
||
The new __Jekyll__ command for importing from various blogs to Jekyll format. | ||
|
||
**Note: _migrators_ are now called _importers_ and are only available if one installs the `jekyll-import` _gem_.** | ||
|
||
How `jekyll-import` works: | ||
--- | ||
## How `jekyll-import` works: | ||
|
||
### Jekyll v2.x | ||
|
||
1. Install the _rubygem_ with `gem install jekyll-import`. | ||
2. Run `jekyll import IMPORTER [options]` | ||
|
||
### Jekyll v1.x | ||
|
||
Launch IRB: | ||
|
||
Install the _rubygem_ with `gem install jekyll-import` | ||
* In your IRB/Ruby configurations, `require jekyll-import` | ||
* For CLI uses, the newly installed CLI command is now a Jekyll plugin/sub-command invoked with `jekyll import` | ||
```ruby | ||
# 1. Require jekyll-import | ||
irb> require 'jekyll-import' | ||
# 2. Choose the importer you'd like to use. | ||
irb> importer_class = "Behance" # an example, there are many others! | ||
# 3. Run it! | ||
irb> JekyllImport::Importers.const_get(importer_class).run(options_hash) | ||
``` | ||
|
||
Read [Blog migrations](http://jekyllrb.com/docs/migrations/) for more detailed info. | ||
## Documentation | ||
|
||
[![Build | ||
Status](https://travis-ci.org/jekyll/jekyll-import.png?branch=master)](https://travis-ci.org/jekyll/jekyll-import) | ||
jekyll-import has its own documentation site, found at http://import.jekyllrb.com. | ||
Dedicated [documentation for each migrator](http://import.jekyllrb.com/docs/home/) is available there. |