jekyll-org-mode-converter 0.1.6 → 0.1.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.org +12 -12
- data/VERSION +1 -1
- data/jekyll-org-mode-converter.gemspec +2 -2
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 431fa2402a74aae26f855c2d82965d491c249a8f
|
4
|
+
data.tar.gz: 807c465d160a7cda5e1a547d45c55cc049215e0b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: be670e2a50fef33acb41865dfcfcfd64b963d5efc37662af6b389eaf8fd7b99a7fb0ad6cc65463e1c11d41792078ed405b37ca6cfa5c546b49f942b7acf88aad
|
7
|
+
data.tar.gz: c4c3e5ad23b14fb72ca856953f13f5026bdcff5ac365257b096ed3b0f0e709859c71912f4b778946473e9537a82c052de4fcc1236f5494e31cab413f2a36463f
|
data/README.org
CHANGED
@@ -20,8 +20,8 @@ While this seems like a great project, it has some problems:
|
|
20
20
|
|
21
21
|
To convert your documents you need to run a separate make file that runs some elisp to convert your org files to html, and then run Jekyll in a sub directory on the converted html to build the resulting website.
|
22
22
|
|
23
|
-
While I understand that hacking Elisp seems like the appropriate course of action for
|
24
|
-
I don't believe *every problem* is best solved
|
23
|
+
While I understand that hacking Elisp always seems like the appropriate course of action for many experienced Emacs users,
|
24
|
+
I don't believe *every problem* is best solved inside Emacs.
|
25
25
|
|
26
26
|
** My approach
|
27
27
|
I decided to approach the problem from a Jekyll point of view. I wanted to use the standard Jekyll workflow, only with Org mode files instead of Markdown files.
|
@@ -79,10 +79,10 @@ bundle exec jekyll serve
|
|
79
79
|
** Deploying to Github
|
80
80
|
One of the cool features of Jekyll is that you can deploy Jekyll websites to Github by simply pushing the Jekyll code
|
81
81
|
to your GitHub remote. Unfortunately for us, Github does not allow you to run custom plugins for [[http://jekyllrb.com/docs/plugins/][security reasons]].
|
82
|
-
This implies that to use [[https://help.github.com/articles/using-jekyll-with-pages/][Jekyll with GitHub Pages]] you ideally need to write posts in Markdown. But
|
82
|
+
This implies that to use [[https://help.github.com/articles/using-jekyll-with-pages/][Jekyll with GitHub Pages]] you ideally need to write posts in Markdown. But we love Org mode and we don't want to learn yet another markup language.
|
83
83
|
|
84
|
-
Luckily all is not lost
|
85
|
-
|
84
|
+
Luckily, all is not lost. We will need to build our site locally and push the static pages to GitHub.
|
85
|
+
My approach is to keep both the Jekyll code and the static HTML in a single repository, which I organize in the following way:
|
86
86
|
|
87
87
|
#+begin_src
|
88
88
|
.
|
@@ -91,13 +91,13 @@ To keep everything tidy I organize my git repository in the following way:
|
|
91
91
|
|
|
92
92
|
|-- www (resulting site goes here)
|
93
93
|
|
|
94
|
-
|-- .nojekyll (prevents GitHub from
|
94
|
+
|-- .nojekyll (prevents GitHub from building our Jekyll code)
|
95
95
|
|
|
96
|
-
|-- index.html (redirects users to www/
|
96
|
+
|-- index.html (redirects users to www/)
|
97
97
|
#+end_src
|
98
98
|
|
99
99
|
|
100
|
-
You
|
100
|
+
You need to configure the destination directory by adding the following line in your ~_config.yml~
|
101
101
|
#+begin_src ruby
|
102
102
|
destination: ../www
|
103
103
|
#+end_src
|
@@ -107,21 +107,21 @@ For relative links to work properly you will also need to set the ~baseurl~ prop
|
|
107
107
|
baseurl: /www
|
108
108
|
#+end_src
|
109
109
|
|
110
|
-
Also, you
|
110
|
+
Also, you should create a file called ~.nojekyll~ to prevent GitHub from trying to build the Jekyll pages in the src directory.
|
111
111
|
|
112
|
-
Create ~index.html~
|
112
|
+
Create ~index.html~ to redirect to the ~wwww~ directory
|
113
113
|
#+begin_src html
|
114
114
|
<html>
|
115
115
|
<meta http-equiv="refresh" content="0; url=www" />
|
116
116
|
</html>
|
117
117
|
#+end_src
|
118
118
|
|
119
|
-
|
119
|
+
Localy you should run ~jekyll build~ on the ~src~ directory and push the results to GitHub.
|
120
120
|
|
121
121
|
|
122
122
|
|
123
123
|
** Example
|
124
|
-
To see an example of the Github deployment method in action, have a look at [[http://tjaartvdwalt.github.io][my personal website]]. You can see the source code [[
|
124
|
+
To see an example of the Github deployment method in action, have a look at [[http://tjaartvdwalt.github.io][my personal website]]. You can see the source code [[https://github.com/tjaartvdwalt/tjaartvdwalt.github.io][here]].
|
125
125
|
|
126
126
|
** Contributing to jekyll-org-mode-converter
|
127
127
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.1.
|
1
|
+
0.1.7
|
@@ -2,11 +2,11 @@
|
|
2
2
|
# DO NOT EDIT THIS FILE DIRECTLY
|
3
3
|
# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
|
4
4
|
# -*- encoding: utf-8 -*-
|
5
|
-
# stub: jekyll-org-mode-converter 0.1.
|
5
|
+
# stub: jekyll-org-mode-converter 0.1.7 ruby lib
|
6
6
|
|
7
7
|
Gem::Specification.new do |s|
|
8
8
|
s.name = "jekyll-org-mode-converter"
|
9
|
-
s.version = "0.1.
|
9
|
+
s.version = "0.1.7"
|
10
10
|
|
11
11
|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
12
12
|
s.require_paths = ["lib"]
|