Skip to content

Commit

Permalink
Added a test post
Browse files Browse the repository at this point in the history
  • Loading branch information
@mzimmerm
mzimmerm committed Jun 23, 2018
1 parent bc8adb2 commit 913a9cc
Show file tree
Hide file tree
Showing 12 changed files with 592 additions and 463 deletions.
2 changes: 1 addition & 1 deletion _config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ paginate: 3

highlighter: rouge
markdown: kramdown
gems: ['jekyll-paginate']
# 2018-06-23: renamed gems: to plugins: and removed - plugins: ['jekyll-paginate']

# Exclude files from "jekyll build"
exclude: ['README.md', 'LICENSE', 'TODO.org']
491 changes: 207 additions & 284 deletions _posts/2017-04-08-a-test-blog.html
View file

Large diffs are not rendered by default.

44 changes: 18 additions & 26 deletions _posts/2017-04-08-blog-in-org-2-jekyll---1.-motivation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
comments: true
---

<div id="outline-container-sec-1" class="outline-2">
<h2 id="sec-1"><span class="section-number-2">1</span> Blog in Org2jekyll - 1. Motivation</h2>
<div id="outline-container-org3e73665" class="outline-2">
<h2 id="org3e73665"><span class="section-number-2">1</span> Blog in Org2jekyll - 1. Motivation</h2>
<div class="outline-text-2" id="text-1">
<p>
This post is part 1 of a short series about writing in org mode.
Expand All @@ -34,10 +34,8 @@ <h2 id="sec-1"><span class="section-number-2">1</span> Blog in Org2jekyll - 1. M
So for a while, I was thinking about available blogging and home page options with a few criteria
</p>
<ul class="org-ul">
<li>Be able to write pages and blog in org mode
</li>
<li>The platform should be more flexible than Blogspot
</li>
<li>Be able to write pages and blog in org mode</li>
<li>The platform should be more flexible than Blogspot</li>
</ul>

<p>
Expand All @@ -49,41 +47,35 @@ <h2 id="sec-1"><span class="section-number-2">1</span> Blog in Org2jekyll - 1. M
</p>
</div>

<div id="outline-container-sec-1-1" class="outline-3">
<h3 id="sec-1-1"><span class="section-number-3">1.1</span> Selecting a package to blog in Org mode in Jekyll</h3>
<div id="outline-container-org25be2b9" class="outline-3">
<h3 id="org25be2b9"><span class="section-number-3">1.1</span> Selecting a package to blog in Org mode in Jekyll</h3>
<div class="outline-text-3" id="text-1-1">
<p>
Jekyll is by default, using Markdown to write blog posts. There seem to be three ways to blog in org-mode with Jekyll:
</p>
<ol class="org-ol">
<li>Ian Barton's <a href="https://github.com/geekinthesticks/ianbarton">example site</a> which is also given most room on org's <a href="http://orgmode.org/worg/org-tutorials/org-jekyll.html">Using org to Blog with Jekyll</a>. One has to still use some amount of Jekyll's Yaml "front matter" in blogs
</li>
<li><a href="https://github.com/eggcaker/jekyll-org">jekyll-org</a> adds ability to use Org mode settings in the "front matter". But to me there seems to be a disadvantage - this package uses Ruby to convert Org to html (rather than org-publish, as the other two packages). While I do not doubt Ruby's Org to html converter is good, I am not sure it completely supports Org syntax.
</li>
<li>Antoine Dumont's <a href="https://github.com/ardumont/org2jekyll">org2jekyll</a>. In my books, this is the <b>best</b> package integrating Jekyll and Org mode posting. I decided to use this package.
</li>
<li>Ian Barton's <a href="https://github.com/geekinthesticks/ianbarton">example site</a> which is also given most room on org's <a href="http://orgmode.org/worg/org-tutorials/org-jekyll.html">Using org to Blog with Jekyll</a>. One has to still use some amount of Jekyll's Yaml "front matter" in blogs</li>
<li><a href="https://github.com/eggcaker/jekyll-org">jekyll-org</a> adds ability to use Org mode settings in the "front matter". But to me there seems to be a disadvantage - this package uses Ruby to convert Org to html (rather than org-publish, as the other two packages). While I do not doubt Ruby's Org to html converter is good, I am not sure it completely supports Org syntax.</li>
<li>Antoine Dumont's <a href="https://github.com/ardumont/org2jekyll">org2jekyll</a>. In my books, this is the <b>best</b> package integrating Jekyll and Org mode posting. I decided to use this package.</li>
</ol>

<p>
The reasons I like <a href="https://github.com/ardumont/org2jekyll">org2jekyll</a> the most:
</p>

<ul class="org-ul">
<li>Only emacs dependencies are used.
</li>
<li>It is fairly easy to configure, although some configuration is still required.
</li>
<li>There is a nice straightforward workflow of pages and blog creating and publishing, all using Org.
</li>
<li>Only emacs dependencies are used.</li>
<li>It is fairly easy to configure, although some configuration is still required.</li>
<li>There is a nice straightforward workflow of pages and blog creating and publishing, all using Org.</li>
</ul>

<p>
In a future post, I will write more on the workflow of blogging using <a href="https://github.com/ardumont/org2jekyll">org2jekyll</a>.
</p>
</div>

<div id="outline-container-sec-1-1-1" class="outline-4">
<h4 id="sec-1-1-1"><span class="section-number-4">1.1.1</span> Selecting a Jekyll theme for my site and blog.</h4>
<div id="outline-container-org6f957e8" class="outline-4">
<h4 id="org6f957e8"><span class="section-number-4">1.1.1</span> Selecting a Jekyll theme for my site and blog.</h4>
<div class="outline-text-4" id="text-1-1-1">
<p>
Next, was looking for a Jekyll theme. There is a huge number of <a href="http://jekyllthemes.org/">Jekyll Themes</a>, the two that I liked the most is the theme used by <a href="https://github.com/ardumont/org2jekyll">org2jekyll</a> - as I decided to use Org2Jekyll anyway that was a great match. This theme is created using the "new Jekyll way", as a Ruby Gem; but I could not get it working. So I decided to use next best, a clean theme named as such - "<a href="https://github.com/scotte/jekyll-clean">jekyll clean</a>".
Expand All @@ -93,8 +85,8 @@ <h4 id="sec-1-1-1"><span class="section-number-4">1.1.1</span> Selecting a Jekyl
</div>


<div id="outline-container-sec-1-2" class="outline-3">
<h3 id="sec-1-2"><span class="section-number-3">1.2</span> Literate programming and live(ly) environments</h3>
<div id="outline-container-orgc4c44fa" class="outline-3">
<h3 id="orgc4c44fa"><span class="section-number-3">1.2</span> Literate programming and live(ly) environments</h3>
<div class="outline-text-3" id="text-1-2">
<p>
Of course if there was a site supporting a kind of <i>literate</i>, <i>live</i> environment such as <a href="https://lively-web.org/welcome.html">Lively Web</a>, <i>I would much prefer that</i>! :)
Expand All @@ -106,8 +98,8 @@ <h3 id="sec-1-2"><span class="section-number-3">1.2</span> Literate programming
</div>
</div>

<div id="outline-container-sec-1-3" class="outline-3">
<h3 id="sec-1-3"><span class="section-number-3">1.3</span> Conclusion</h3>
<div id="outline-container-org99e1aa9" class="outline-3">
<h3 id="org99e1aa9"><span class="section-number-3">1.3</span> Conclusion</h3>
<div class="outline-text-3" id="text-1-3">
<p>
This is a first post in this blog on <a href="https://github.io">github.io</a>, using <a href="https://jekyllrb.com">Jekyll</a> with the theme <a href="https://github.com/scotte/jekyll-clean">jekyll clean</a>, the post written in the amazing Emacs's <a href="http://orgmode.org/">org-mode</a>, using <a href="https://github.com/ardumont/org2jekyll">org2jekyll</a>.
Expand Down
74 changes: 30 additions & 44 deletions _posts/2017-04-14-blog-in-org-2-jekyll---2.-configure-all-software.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,25 @@
comments: true
---

<div id="outline-container-sec-1" class="outline-2">
<h2 id="sec-1"><span class="section-number-2">1</span> Blog in Org2jekyll - 2. Configuring all software</h2>
<div id="outline-container-org5ccf486" class="outline-2">
<h2 id="org5ccf486"><span class="section-number-2">1</span> Blog in Org2jekyll - 2. Configuring all software</h2>
<div class="outline-text-2" id="text-1">
<p>
This post is part 2 of <a href="{% post_url 2017-04-08-blog-in-org-2-jekyll---1.-motivation %}">a short series about writing in org mode</a>, specifically using org2jekyll .
This post is part 2 of <a href="{% post_url 2017-04-08-blog-in-org-2-jekyll---1.-motivation %}">a short series about writing in org mode</a>, specifically using org2jekyll to write a blog in org mode and jekyll.
</p>

<p>
Here I describe how I configured the environment used for this site and blog <a href="https://mzimmerm.github.io">https://mzimmerm.github.io</a>. The motivation for using <a href="https://github.io">https://github.io</a> was to setup environment which is:
Here I describe how I configured the environment used for this site and blog <a href="https://mzimmerm.github.io">https://mzimmerm.github.io</a>.
</p>

<p>
The motivation for using <a href="https://github.io">https://github.io</a> was to setup environment which is:
</p>

<ul class="org-ul">
<li>Hosted (I do not need to manage the web server etc)
</li>
<li>Allows to write pages and blog posts in org mode
</li>
<li>The platform should allow more control than Blogspot or Google Sites (judged at my limited familiarity level with the two)
</li>
<li>Hosted (I do not need to manage the web server etc)</li>
<li>Allows to write pages and blog posts in org mode</li>
<li>The platform should allow more control than Blogspot or Google Sites (judged at my limited familiarity level with the two)</li>
</ul>

<p>
Expand All @@ -44,65 +45,50 @@ <h2 id="sec-1"><span class="section-number-2">1</span> Blog in Org2jekyll - 2. C
</p>

<ul class="org-ul">
<li><a href="https://github.io">github.io</a> (which enforces <a href="https://jekyllrb.com/">Jekyll</a> as the website builder)
</li>
<li><a href="https://jekyllrb.com/">Jekyll</a> as the website builder) with theme theme <a href="https://github.com/scotte/jekyll-clean">jekyll clean</a>
</li>
<li>Using <a href="https://github.com/ardumont/org2jekyll">org2jekyll</a> to write posts in <a href="http://orgmode.org/">org-mode</a>. This also allows writing Math using <a href="http://asciimath.org/">ASCIIMath</a> and LaTex.
</li>
<li><a href="https://github.io">github.io</a> (which enforces <a href="https://jekyllrb.com/">Jekyll</a> as the website builder)</li>
<li><a href="https://jekyllrb.com/">Jekyll</a> as the website builder) with theme theme <a href="https://github.com/scotte/jekyll-clean">jekyll clean</a></li>
<li>Using <a href="https://github.com/ardumont/org2jekyll">org2jekyll</a> to write posts in <a href="http://orgmode.org/">org-mode</a>. This also allows writing Math using <a href="http://asciimath.org/">ASCIIMath</a> and LaTex.</li>
</ul>

<p>
Below is a quick summary of setup steps that achieved installation of this block software stack.
</p>

<ol class="org-ol">
<li><b>Setup Github Pages on <a href="https://github.io">github.io</a></b>: I created my github page, and cloned it to my local directory, <code>BLOG=\~/mzimmerm.github.io</code> . This step is best described in <a href="https://pages.github.com/">https://pages.github.com/</a>. The end result of this step was a local directory, synchronized with my repo at <a href="https://github.com/mzimmerm/mzimmerm.github.io">https://github.com/mzimmerm/mzimmerm.github.io</a>. It only contained index.html.
</li>
<li><b>Setup Github Pages on <a href="https://github.io">github.io</a></b>: I created my github page, and cloned it to my local directory, <code>BLOG=\~/mzimmerm.github.io</code> . This step is best described in <a href="https://pages.github.com/">https://pages.github.com/</a>. The end result of this step was a local directory, synchronized with my repo at <a href="https://github.com/mzimmerm/mzimmerm.github.io">https://github.com/mzimmerm/mzimmerm.github.io</a>. It only contained index.html.</li>
<li><b>Setup <a href="https://jekyllrb.com">Jekyll</a> with theme <a href="https://github.com/scotte/jekyll-clean">jekyll clean</a></b>: Next I decided to use a particular Jekyll theme I like from github, the jekyll clean theme. To this goal,
<ul class="org-ul">
<li>I overwrote the contents of my local <code>$BLOG</code> by going to <a href="https://github.com/scotte/jekyll-clean">https://github.com/scotte/jekyll-clean</a>, selecting "clone or download", then "download", and unzipping the downloaded zip into <code>$BLOG</code>.
</li>
<li>Also, I created a new directory <code>org</code> in <code>$BLOG</code>. In this directory, I am writing my posts in org mode. This is needed for Org2jekyll - see next step
</li>
</ul>
</li>
<li>I overwrote the contents of my local <code>$BLOG</code> by going to <a href="https://github.com/scotte/jekyll-clean">https://github.com/scotte/jekyll-clean</a>, selecting "clone or download", then "download", and unzipping the downloaded zip into <code>$BLOG</code>.</li>
<li>Also, I created a new directory <code>org</code> in <code>$BLOG</code>. In this directory, I am writing my posts in org mode. This is needed for Org2jekyll - see next step</li>
</ul></li>
<li><b>Setup <a href="https://github.com/ardumont/org2jekyll">org2jekyll</a> in Emacs</b>: As I decided Org2jekyll is the best environment for Org mode and Jekyll, I did
<ul class="org-ul">
<li>Run <code>M-x package-list-packages</code> from emacs, which installed Org2jekyll in my Emacs from Emacs package manager (alternatively, you can download and install the files from <a href="https://github.com/ardumont/org2jekyll">https://github.com/ardumont/org2jekyll</a>). Package manager is much much better and easier.
</li>
</ul>
</li>
<li>Run <code>M-x package-list-packages</code> from emacs, which installed Org2jekyll in my Emacs from Emacs package manager (alternatively, you can download and install the files from <a href="https://github.com/ardumont/org2jekyll">https://github.com/ardumont/org2jekyll</a>). Package manager is much much better and easier.</li>
</ul></li>
<li><b>Configure org2jekyll</b>: Emacs need to be customized to "know" about the "source" directory where you write posts in Org, and the "target" directories where org publishes them
<ul class="org-ul">
<li>In <code>init.el</code>, add a section similar to this: <a href="https://github.com/ardumont/org2jekyll#setup">https://github.com/ardumont/org2jekyll#setup</a>.
</li>
<li>In <code>init.el</code>, add a section similar to this: <a href="https://github.com/ardumont/org2jekyll#setup">https://github.com/ardumont/org2jekyll#setup</a>.</li>
<li>The important step of the setup is to "<b>get the directories right</b>". We only need to change three custom-set variables. Here are notes on how to do it:
<ul class="org-ul">
<li><code>org2jekyll-source-directory</code> points to the "source" directory where posts are created in org format - this should be the full path to the <code>org</code> directory.
</li>
<li><code>(org2jekyll-jekyll-directory</code> points to the "target" location where org publishes. This should be the top level of the blog, <code>$BLOG</code>.
</li>
<li><code>org2jekyll-blog-author</code> is the author name.
</li>
</ul>
</li>
</ul>
</li>
<li><code>org2jekyll-source-directory</code> points to the "source" directory where posts are created in org format - this should be the full path to the <code>org</code> directory.</li>
<li><code>(org2jekyll-jekyll-directory</code> points to the "target" location where org publishes. This should be the top level of the blog, <code>$BLOG</code>.</li>
<li><code>org2jekyll-blog-author</code> is the author name.</li>
</ul></li>
</ul></li>
</ol>
</div>

<div id="outline-container-sec-1-1" class="outline-3">
<h3 id="sec-1-1"><span class="section-number-3">1.1</span> Note</h3>
<div id="outline-container-org4f4b0a5" class="outline-3">
<h3 id="org4f4b0a5"><span class="section-number-3">1.1</span> Note</h3>
<div class="outline-text-3" id="text-1-1">
<p>
The Jekyll theme I use, is created by the "legacy method" - it is a plain directory tree with files. More recent themes are created as a Ruby Gem. My overall theme preference would be the theme used by Org2Jekyll in <a href="https://github.com/ardumont/org2jekyll">https://github.com/ardumont/org2jekyll</a> which uses the Gem method but I was unable to build it. Ruby configuration is convoluted, even with RVM.
</p>
</div>
</div>

<div id="outline-container-sec-1-2" class="outline-3">
<h3 id="sec-1-2"><span class="section-number-3">1.2</span> Conclusion</h3>
<div id="outline-container-org9e6be74" class="outline-3">
<h3 id="org9e6be74"><span class="section-number-3">1.2</span> Conclusion</h3>
<div class="outline-text-3" id="text-1-2">
<p>
Configuring the environment used for this site and blog <a href="https://mzimmerm.github.io">https://mzimmerm.github.io</a> took Step 1 - 4 described above.
Expand Down
Loading

0 comments on commit 913a9cc

Please sign in to comment.