Merge remote-tracking branch 'srht/master'
[worg.git] / org-blog-wiki.org
blob227ed358787e805e0d5e2bde878d67d8113362fd
1 #+TITLE:      Blogs and Wikis with Org
2 #+AUTHOR:     Worg people
3 #+EMAIL:      mdl AT imapmail DOT org
4 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
5 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
6 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
7 #+LANGUAGE:   en
8 #+PRIORITIES: A C B
9 #+CATEGORY:   worg
10 #+OPTIONS:    H:3 num:nil toc:nil \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
11 #+HTML_LINK_UP:    index.html
12 #+HTML_LINK_HOME:  https://orgmode.org/worg/
14 # This file is released by its authors and contributors under the GNU
15 # Free Documentation license v1.3 or later, code examples are released
16 # under the GNU General Public License v3 or later.
18 [[file:index.org][{Back to Worg's index}]]
20 There is a strong desire to use Org-mode to manage both blogs and
21 wikis.  There are a number of tools which address parts of this need, this
22 page will serve as a collecting of the names of these tools with links and
23 brief descriptions.  I'm sure I've forgotten many relevant tools so *please
24 contribute*!
26 * Blogging tools
28 - [[http://renard.github.com/o-blog][o-blog]] :: Stand-alone blogging system that does not require any external
29      software ([[http://renard.github.com/o-blog/features.html][features]], [[https://github.com/renard/o-blog][Github source]]).
31 - [[http://jekyllrb.com/][Jekyll]] :: a simple, blog aware, static site generator.  There are
32      instructions for combining Org-mode with jekyll at [[file:org-tutorials/org-jekyll.org][Org-Jekyll]].
34 - [[https://orgmode.org/manual/Publishing.html][Projects]] :: In most cases using [[https://orgmode.org/manual/Publishing.html][Org-mode publishing projects]] with
35      its many options should be sufficient for publishing a blog.
37 - [[file:blorgit.org][Blorgit]] :: publish an interactive website based on Org-mode
38      documents.  While blorgit has many nice features including the
39      fact that Org-mode documents can be edited through the web
40      interface with automatic commits to a git or svn repository
41      however it is fairly complicated to set up.  Blorgit is one or
42      two small changes from being a full-fledged Org-mode based wiki.
43      This is no longer maintained, see org-ehtml in the wiki section
44      below.
46 - [[https://github.com/punchagan/blog-files][blog-files]] :: A simple system based on ideas and code from
47      org-jekyll and reprise.py to publish a blog using simple static
48      html pages.
50 - [[https://github.com/punchagan/org2blog][org2blog]] :: allows publishing directly from Org-mode to WordPress
52 - [[http://jaderholm.com/blog/blogging-with-org-mode-and-octopress][Org-mode and Octopress]] :: Instructions for blogging With Org-mode
53      and Octopress.  There is also this [[https://github.com/craftkiller/orgmode-octopress][dedicated exporter]] by Tom
54      Alexander (instructions [[http://blog.paphus.com/blog/2012/08/01/introducing-octopress-blogging-for-org-mode/][here]].)
56 - [[http://www.emacswiki.org/emacs/Blorg][Blorg]] :: the original Org-mode blogging engine (but it's not
57      maintained anymore).  Roland Kaufmann is maintaining a fork [[https://github.com/RolKau/blorg][here]].
59 - [[http://comments.gmane.org/gmane.emacs.orgmode/45360][a blog-like sitemap for org-publish]] :: see [[http://comments.gmane.org/gmane.emacs.orgmode/45360][this post]] by Jon Anders
60      Skorpen.
62 - [[http://plugins.getnikola.com/#orgmode][Org-mode and Nikola]] :: A plugin for [[http://getnikola.com][Nikola]] (a static site generator
63      in Python), that lets you write your posts in org-mode syntax.
65 - [[https://github.com/kelvinh/org-page][org-page]] :: A static blog-site generator, written in elisp. Very
66      light weight. Integrated with git. Supports themeing. Uses
67      [[http://mustache.github.io/][mustache]] for templating. Highly customizable. Key difference from
68      o-blog is that org-page posts are in *separate* org-files. Built-in
69      support for disqus, google-analytics and RSS.
71 - [[https://github.com/novoid/lazyblorg][lazyblorg]] :: a static blog-site generator written in Python (HTML5,
72      CSS3). Focus is to have only an absolutely /minimum/ of things to
73      do to write a new blog entry /everywhere/ in your set of Org-mode
74      files. The software is [[https://github.com/novoid/lazyblorg/blob/master/lazyblorg.org][currently in development]]. However, basic
75      functionality is working: tagging, Atom feeds, basic Org-mode
76      syntax parser with Pandoc fall-back, hidden blog entries,
77      auto-tags for language, tag cloud link page, tag description
78      pages, and such. You can take a look at [[http://karl-voit.at/][Karl Voit]]'s personal web
79      page to see an example result. Great features are planned for the
80      future: auto-tags for article length, overview pages for
81      navigation, extremely easy integration of image files through [[https://github.com/novoid/Memacs/blob/master/docs/memacs_filenametimestamps.org][a
82      memacs module]], and so forth.
84 - [[https://gohugo.io/][Hugo]] :: Hugo fast static blog engine supports Org files natively.
86 - [[https://ox-hugo.scripter.co][ox-hugo]] :: An Org exporter backend that exports to
87      [[https://gohugo.io][Hugo]]/Blackfriday-friendly Markdown, along with Hugo front-matter
88      in TOML or YAML. This package was developed after being aware of
89      the fact that Hugo natively supports parsing Org (but that
90      support is only partial).. read more on [[https://ox-hugo.scripter.co/doc/why-ox-hugo/][Why =ox-hugo=?]]
92      =ox-hugo= enables writing posts for Hugo in *native Org mode*. It
93      allows converting your existing Org files to blog posts with
94      almost no modification. Two common Org blogging flows are
95      supported:
96   - Exporting multiple Org sub-trees from a single file to multiple
97     Hugo posts. With this feature, one can produce a whole web site
98     from a single Org file (the [[https://ox-hugo.scripter.co][=ox-hugo= documentation site]] is one
99     such example, which is generated from [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/doc/ox-hugo-manual.org][this one Org file]]). It also
100     leverages Org tag and property inheritance, and much more!
101   - Exporting a single Org file to a single Hugo post.
103   See the package's website for complete documentation, and the [[https://ox-hugo.scripter.co/test/][test
104   site]] [[[https://github.com/kaushalmodi/ox-hugo/tree/master/test/site/content-org][source]]] for hundreds of test cases and feature
105   demonstrations.
107 - [[https://github.com/bastibe/org-static-blog/][org-static-blog]] :: This is a blog generator that focuses on being
108      simple.  It has no dependency beside Emacs.  All files are simple
109      org-mode files in a directory.  The index, the archive and the
110      RSS feed are automatically generated.  See [[https://bastibe.de/][Basti's]] website for an
111      example.
113 * Wiki tools
115 - [[http://ikiwiki.info/][ikiwiki]] is a web site compiler written in Perl.  In many ways it is
116   similar to Jekyll, but has closer integration with version control
117   systems.  It supports blogging and has many plugins.
119   There is an org mode plugin by [[http://www.golden-gryphon.com/blog/manoj/blog/2008/06/08/Using_org-mode_with_Ikiwiki/][Manoj]], which lets you write your posts in
120   org and converts them to html suitable for processing by ikiwiki.
122   There is [[https://github.com/chrismgray/ikiwiki-org-plugin][another plugin]] by Chris Gray that interprets org files.  It
123   is still under intermittent development, but is stable enough for
124   general use.
126 - [[https://github.com/eschulte/org-ehtml][Org-ehtml]] defines an editable HTML backend for the new exporting
127   engine.  Org-ehtml runs on an [[https://github.com/eschulte/emacs-web-server][Emacs web server]].  Exported Org-mode
128   web pages may be edited through a web browser, the edits may then be
129   saved to Org-mode files on the computer running the server, and may
130   even be committed to a version control system (experimental)
131   providing wiki functionality.  There is also experimental support
132   for password authentication.  Also see the [[https://list.orgmode.org/87pq6ua0kk.fsf@gmx.com][initial announcement
133   email on the Org-mode mailing list]].
135 * Other tools
137 - [[file:org-tutorials/org-ruby.org][org-ruby]] is a Ruby gem for converting org-mode files to HTML. The goal is
138   to make it easier to use org-mode files in website tools like [[http://webby.rubyforge.org/][Webby]],
139   [[http://jekyllrb.com/][Jekyll]], or [[http://webgen.rubyforge.org/][webgen]].
141 * More links
143 - [[http://emacs-fu.blogspot.com/2009/05/writing-and-blogging-with-org-mode.html][Writing and blogging with org-mode]]
144 - [[http://blog.herraiz.org/archives/241][Using Emacs org-mode for web publishing]]