Skip to content

Commit 57e2e8c

Browse files
ashmaroliashmaroli
committed
New Docs
1 parent d54e910 commit 57e2e8c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+886
-1010
lines changed

‎Rakefile

+2-48
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,8 @@ namespace :site do
124124
if File.exist?("History.markdown")
125125
history_file = File.read("History.markdown")
126126
front_matter = {
127-
"layout" => "docs",
128-
"title" => "History",
129-
"permalink" => "/docs/history/",
130-
"prev_section" => "contributing",
127+
"title" => "Project History",
128+
"doc_order" => 6,
131129
}
132130
Dir.chdir("docs/_docs/") do
133131
File.open("history.md", "w") do |file|
@@ -145,48 +143,4 @@ namespace :site do
145143
abort "You seem to have misplaced your History.markdown file. I can haz?"
146144
end
147145
end
148-
149-
desc "generate importer-dependencies data file"
150-
task :generate_dependency_data do
151-
require "jekyll-import"
152-
153-
# Monkey-patch to alter behavior just for this task.
154-
module JekyllImport
155-
def self.require_with_fallback(gems)
156-
Array(gems).flatten
157-
end
158-
end
159-
160-
data_dir = File.expand_path("docs/_data", __dir__)
161-
data_file = File.join(data_dir, "importer_dependencies.yml")
162-
importers = JekyllImport::Importer.subclasses
163-
label_size = importers.map { |klass| klass.to_s.split("::").last.length }.max + 1
164-
165-
# available as part of Ruby Stdlib
166-
std_lib = %w(csv date fileutils json net/http open-uri rss rubygems time uri yaml)
167-
168-
FileUtils.mkdir_p data_dir
169-
data = {}
170-
171-
puts "\nLogging importer dependencies..\n\n"
172-
importers.each do |importer|
173-
doc_name = importer.to_s.split("::").last.downcase
174-
deps = importer.require_deps - std_lib
175-
next if deps.empty?
176-
177-
deps.map! { |dep| dep.start_with?("active_support") ? "activesupport" : dep.split("/")[0] }
178-
deps = deps - std_lib
179-
deps.uniq!
180-
deps.sort!
181-
puts "#{doc_name.ljust(label_size)}: #{deps.join(", ")}"
182-
data[doc_name] = deps
183-
end
184-
185-
File.write(data_file, YAML.dump(data))
186-
puts <<~MSG
187-
\nData successfully logged into file:
188-
=> #{data_file}
189-
Commit the file into version control if altered.
190-
MSG
191-
end
192146
end

‎docs/_config.yml

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
title: "jekyll-import • Import your old &amp; busted site to Jekyll"
22
url: https://import.jekyllrb.com
3-
highlighter: rouge
4-
relative_permalinks: false
5-
permalink: /news/:year/:month/:day/:title/
6-
excerpt_separator: ""
73
repository: https://github.com/jekyll/jekyll-import
8-
latest_release: 0.14.0
4+
permalink: pretty
95

106
collections:
117
docs:
128
output: true
9+
sort_by: doc_order
1310
importers:
1411
output: true
1512

16-
sass:
17-
style: compressed
13+
defaults:
14+
- { scope: { type: importers }, values: { layout: importer, title_suffix: " Importer" } }
15+
- { scope: { type: docs }, values: { layout: docs } }

‎docs/_docs/contributing.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
---
2-
layout: docs
3-
title: Contributing
4-
prev_section: third-party
5-
next_section: history
6-
permalink: /docs/contributing/
2+
doc_order: 4
73
---
84

95
jekyll-import is entirely open-source, which means we need your help to make it better!
@@ -28,7 +24,7 @@ So you have a new system you want to be able to import from? Great! It's pretty
2824
First thing's first: create the file where the importer will go. In this case, that will be `lib/jekyll-import/importers/columbus.rb`.
2925
Inside this file, we'll add this template:
3026

31-
{% highlight ruby %}
27+
```ruby
3228
module JekyllImport
3329
module Importers
3430
class Columbus < Importer
@@ -59,7 +55,7 @@ module JekyllImport
5955
end
6056
end
6157
end
62-
{% endhighlight %}
58+
```
6359

6460
Let's go through this quickly.
6561

@@ -79,16 +75,17 @@ Where the magic happens! This method should read from your *Columbus* source, th
7975

8076
This function is entirely optional, but allows for some validation of the options. This method allows you to validate the options in any way you wish. For example:
8177

82-
{% highlight ruby %}
78+
```ruby
8379
def self.validate(opts)
8480
abort "Specify a username!" if opts["username"].nil?
8581
abort "Your username must be a number." unless opts["username"].match(%r!\A\d+\z!)
8682
end
87-
{% endhighlight %}
83+
```
8884

8985
Once you have your importer working (test with `script/console`), then you're ready to add **documentation**. Add your new file:
9086
`./docs/_importers/columbus.md`. Take a look at one of the other importers as an example. You just add basic usage and you're golden.
9187

9288
All set? Add everything to a branch on your fork of `jekyll-import` and
9389
[submit a pull request](https://github.com/jekyll/jekyll-import/compare/).
90+
9491
Thank you!

‎docs/_docs/history.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
---
2-
layout: docs
3-
title: History
4-
permalink: "/docs/history/"
5-
prev_section: contributing
2+
title: Project History
3+
doc_order: 6
64
---
75

86
## 0.21.0 / 2021-10-31
@@ -25,6 +23,7 @@ prev_section: contributing
2523
- Clean up code to make Rubocop happy ([#441]({{ site.repository }}/issues/441))
2624
- Set up GH Action for Continuous Integration ([#449]({{ site.repository }}/issues/449))
2725
- Refactor Blogger importer with guard clauses ([#452]({{ site.repository }}/issues/452))
26+
- Add workflow to automate tagging and releasing gem ([#459]({{ site.repository }}/issues/459))
2827

2928
### Documentation
3029

‎docs/_docs/index.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
---
2-
layout: docs
3-
title: Getting started
4-
next_section: installation
5-
permalink: /docs/home/
2+
title: Getting Started
3+
permalink: /docs/
4+
doc_order: 1
65
---
76

8-
If you’re switching to Jekyll from another blogging system, Jekyll’s importers
9-
can help you with the move. Most methods listed on this page require read access
10-
to the database from your old system to generate posts for Jekyll. Each method
11-
generates `.markdown` posts in the `_posts` directory based on the entries in
12-
the foreign system.
7+
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
8+
require read access to the database from your old system to generate posts for Jekyll. Each method generates `.markdown` posts in the `_posts`
9+
directory based on the entries in the foreign system.
1310

1411
## Other Systems
1512

16-
If you have a system for which there is currently no migrator, consider writing
17-
one and sending us [a pull request](https://github.com/jekyll/jekyll-import).
13+
If you have a system for which there is currently no migrator, [consider writing one][creating_importer] and sending us a pull request.
14+
15+
[creating_importer]: {{ '/docs/contributing#creating-a-new-importer' | relative_url }}

‎docs/_docs/installation.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
---
2-
layout: docs
3-
title: Installation
4-
prev_section: home
5-
next_section: usage
6-
permalink: /docs/installation/
2+
doc_order: 2
73
---
84

95
Because the importers have many of their own dependencies, they are made

‎docs/_docs/third-party.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Third-party Importers
3+
doc_order: 5
4+
---
5+
6+
Various third-party importers for Jekyll have been created separate from this
7+
gem. They are as below:
8+
9+
### Blogger (Blogspot)
10+
11+
To import posts from Blogger, see [this post about migrating from Blogger to
12+
Jekyll](http://blog.coolaj86.com/articles/migrate-from-blogger-to-jekyll.html). If
13+
that doesn’t work for you, you might want to try some of the following
14+
alternatives:
15+
16+
- [@kennym](https://github.com/kennym) created a [little migration
17+
script](https://gist.github.com/1115810), because the solutions in the
18+
previous article didn't work out for him.
19+
- [@ngauthier](https://github.com/ngauthier) created [another
20+
importer](https://gist.github.com/1506614) that imports comments, and does so
21+
via blogger’s archive instead of the RSS feed.
22+
- [@juniorz](https://github.com/juniorz) created [yet another
23+
importer](https://gist.github.com/1564581) that works for
24+
[Octopress](http://octopress.org). It is like [@ngauthier’s
25+
version](https://gist.github.com/1506614) but separates drafts from posts, as
26+
well as importing tags and permalinks.
27+
- [@dseeman](https://github.com/dseeman) created [seriously, yet another](https://gist.github.com/dseeman/a1f0bd96d4511a8f156e)
28+
importer based on the work of [@ngauthier’s version](https://gist.github.com/1506614).
29+
it accepts an xml file from any blog (not just blogger) but does not
30+
include support for comments or drafts. It also converts the html files
31+
into markdown files.

‎docs/_docs/usage.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
---
2-
layout: docs
3-
title: Usage
4-
prev_section: installation
5-
next_section: behance
6-
permalink: /docs/usage/
2+
doc_order: 3
73
---
84

95
You should now be all set to run the importers with the following incantation:

‎docs/_importers/behance.md

+1-19
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,3 @@
11
---
2-
layout: docs
3-
title: Behance
4-
importer: true
5-
prev_section: usage
6-
link_source: behance
7-
next_section: blogger
8-
permalink: /docs/behance/
2+
prereq_info: To import your posts from Behance, generate an API token for your user account.
93
---
10-
11-
To import your posts from your [Behance](http://behance.com), generate an API token for your user account and run:
12-
13-
{% highlight bash %}
14-
$ ruby -r rubygems -e 'require "jekyll-import";
15-
JekyllImport::Importers::Behance.run({
16-
"user" => "my_username",
17-
"api_token" => "my_api_token"
18-
})'
19-
{% endhighlight %}
20-
21-
Both `user` and `api_token` are required.

‎docs/_importers/blogger.md

+5-25
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,9 @@
11
---
2-
layout: docs
3-
title: Blogger
4-
importer: true
5-
prev_section: behance
6-
link_source: blogger
7-
next_section: csv
8-
permalink: /docs/blogger/
9-
---
10-
11-
To import your posts from your [Blogger](https://www.blogger.com/),
12-
you first have to [export the blog][export-blogger-xml]
13-
to a XML file (`blog-MM-DD-YYYY.xml`),
14-
and run:
15-
{% highlight bash %}
16-
$ ruby -r rubygems -e 'require "jekyll-import";
17-
JekyllImport::Importers::Blogger.run({
18-
"source" => "/path/to/blog-MM-DD-YYYY.xml",
19-
"no-blogger-info" => false, # not to leave blogger-URL info (id and old URL) in the front matter
20-
"replace-internal-link" => false, # replace internal links using the post_url liquid tag.
21-
})'
22-
{% endhighlight %}
2+
prereq_info: |-
3+
To import your posts from Blogger, you have to first [export the blog][export-blogger-xml]
4+
to an XML file (`blog-MM-DD-YYYY.xml`).
235
24-
The only required field is `source`.
25-
The other fields default to their above values.
6+
[export-blogger-xml]: https://support.google.com/blogger/answer/97416 "Export or import your blog - Blogger Help"
7+
---
268

279
"Labels" will be included in export as "Tags".
28-
29-
[export-blogger-xml]: https://support.google.com/blogger/answer/97416 "Export or import your blog - Blogger Help"

‎docs/_importers/csv.md

+2-24
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,7 @@
11
---
2-
layout: docs
32
title: CSV
4-
prev_section: blogger
5-
link_source: csv
6-
next_section: drupal6
7-
permalink: /docs/csv/
83
---
94

10-
To import your posts from a CSV file, run:
11-
12-
{% highlight bash %}
13-
$ ruby -r rubygems -e 'require "jekyll-import";
14-
JekyllImport::Importers::CSV.run({
15-
"file" => "my_posts.csv"
16-
})'
17-
{% endhighlight %}
18-
195
Your CSV file will be read in with the following columns:
206

217
1. title
@@ -25,13 +11,5 @@ Your CSV file will be read in with the following columns:
2511
5. filter (e.g. markdown, textile)
2612

2713
If you wish to specify custom front matter for each of your posts, you
28-
can use the `no-front-matter` option to prevent the default front matter
29-
from being written to the imported files:
30-
31-
{% highlight bash %}
32-
$ ruby -r rubygems -e 'require "jekyll-import";
33-
JekyllImport::Importers::CSV.run({
34-
"file" => "my_posts.csv",
35-
"no-front-matter" => true
36-
})'
37-
{% endhighlight %}
14+
can use the `--no-front-matter` option to prevent the default front matter
15+
from being imparted to the imported files.

‎docs/_importers/dotclear.md

+1-16
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
11
---
2-
layout: docs
3-
title: Dotclear
4-
prev_section: csv
5-
link_source: dotclear
6-
next_section: drupal6
7-
permalink: /docs/dotclear/
2+
title: dotClear
83
---
9-
10-
To import your posts from a dotclear file, run:
11-
12-
{% highlight bash %}
13-
$ ruby -r rubygems -e 'require "jekyll-import";
14-
JekyllImport::Importers::Dotclear.run({
15-
"datafile" => "2019-....-backup.txt",
16-
"mediafolder" => "path/to/the/media (media.zip inflated)"
17-
})'
18-
{% endhighlight %}

‎docs/_importers/drupal6.md

+4-38
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,9 @@
11
---
2-
layout: docs
32
title: Drupal 6
4-
prev_section: csv
5-
link_source: drupal6
6-
next_section: drupal7
7-
permalink: /docs/drupal6/
83
---
94

10-
To import your posts from a [Drupal 6](http://drupal.org) installation, run:
5+
By default, the importer will pull in nodes of type `blog`, `story`, and `article`.
6+
To specify custom types, you may use the `types` option while invoking the importer.
117

12-
{% highlight bash %}
13-
$ ruby -r rubygems -e 'require "jekyll-import";
14-
JekyllImport::Importers::Drupal6.run({
15-
"dbname" => "name",
16-
"user" => "myuser",
17-
"password" => "mypassword",
18-
"host" => "myhost",
19-
"prefix" => "mytableprefix",
20-
"types" => ["blog", "story", "article"]
21-
})'
22-
{% endhighlight %}
23-
24-
The only required fields are `dbname` and `user`. `password` defaults to `""`,
25-
`host` defaults to `"localhost"`, and `prefix` defaults to `""`.
26-
27-
By default, this will pull in nodes of type `blog`, `story`, and `article`.
28-
To specify custom types, you can use the `types` option when you run the
29-
importer:
30-
31-
{% highlight bash %}
32-
$ ruby -r rubygems -e 'require "jekyll-import";
33-
JekyllImport::Importers::Drupal6.run({
34-
"dbname" => "name",
35-
"user" => "myuser",
36-
"password" => "mypassword",
37-
"host" => "myhost",
38-
"prefix" => "mytableprefix",
39-
"types" => ["blog", "post"]
40-
})'
41-
{% endhighlight %}
42-
43-
That will import nodes of type `blog` and `post` only.
8+
The default Drupal 6 expects database to be MySQL. If you want to import posts from
9+
Drupal 6 installation with PostgreSQL define, pass `postgresql` to the `--engine` option.

0 commit comments

Comments
 (0)