Add a new meta-FAQ :)
[worg.git] / org-blog-wiki.org
blob0452a2ae2192bb242d2bf3e20f1439ec1cb35c2c
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
12 [[file:index.org][{Back to Worg's index}]]
14 There is a strong desire to use Org-mode to manage both blogs and
15 wikis.  There are a number of tools which address parts of this need, this
16 page will serve as a collecting of the names of these tools with links and
17 brief descriptions.  I'm sure I've forgotten many relevant tools so *please
18 contribute*!
20 * Blogging tools
22 - [[http://renard.github.com/o-blog][o-blog]] :: Stand-alone blogging system that does not require any external
23      software ([[http://renard.github.com/o-blog/features.html][features]], [[https://github.com/renard/o-blog][Github source]]).
25 - [[http://jekyllrb.com/][Jekyll]] :: a simple, blog aware, static site generator.  There are
26      instructions for combining Org-mode with jekyll at [[file:org-tutorials/org-jekyll.org][Org-Jekyll]].
28 - [[https://orgmode.org/manual/Publishing.html][Projects]] :: In most cases using [[https://orgmode.org/manual/Publishing.html][Org-mode publishing projects]] with
29      its many options should be sufficient for publishing a blog.
31 - [[file:blorgit.org][Blorgit]] :: publish an interactive website based on Org-mode
32      documents.  While blorgit has many nice features including the
33      fact that Org-mode documents can be edited through the web
34      interface with automatic commits to a git or svn repository
35      however it is fairly complicated to set up.  Blorgit is one or
36      two small changes from being a full-fledged Org-mode based wiki.
37      This is no longer maintained, see org-ehtml in the wiki section
38      below.
40 - [[https://github.com/punchagan/blog-files][blog-files]] :: A simple system based on ideas and code from
41      org-jekyll and reprise.py to publish a blog using simple static
42      html pages.
44 - [[https://github.com/punchagan/org2blog][org2blog]] :: allows publishing directly from Org-mode to WordPress
46 - [[http://jaderholm.com/blog/blogging-with-org-mode-and-octopress][Org-mode and Octopress]] :: Instructions for blogging With Org-mode
47      and Octopress.  There is also this [[https://github.com/craftkiller/orgmode-octopress][dedicated exporter]] by Tom
48      Alexander (instructions [[http://blog.paphus.com/blog/2012/08/01/introducing-octopress-blogging-for-org-mode/][here]].)
50 - [[http://www.emacswiki.org/emacs/Blorg][Blorg]] :: the original Org-mode blogging engine (but it's not
51      maintained anymore).  Roland Kaufmann is maintaining a fork [[https://github.com/RolKau/blorg][here]].
53 - [[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
54      Skorpen.
56 - [[http://plugins.getnikola.com/#orgmode][Org-mode and Nikola]] :: A plugin for [[http://getnikola.com][Nikola]] (a static site generator
57      in Python), that lets you write your posts in org-mode syntax.
59 - [[https://github.com/kelvinh/org-page][org-page]] :: A static blog-site generator, written in elisp. Very
60      light weight. Integrated with git. Supports themeing. Uses
61      [[http://mustache.github.io/][mustache]] for templating. Highly customizable. Key difference from
62      o-blog is that org-page posts are in *separate* org-files. Built-in
63      support for disqus, google-analytics and RSS.
65 - [[https://github.com/novoid/lazyblorg][lazyblorg]] :: a static blog-site generator written in Python (HTML5,
66      CSS3). Focus is to have only an absolutely /minimum/ of things to
67      do to write a new blog entry /everywhere/ in your set of Org-mode
68      files. The software is [[https://github.com/novoid/lazyblorg/blob/master/lazyblorg.org][currently in development]]. However, basic
69      functionality is working: tagging, Atom feeds, basic Org-mode
70      syntax parser with Pandoc fall-back, hidden blog entries,
71      auto-tags for language, tag cloud link page, tag description
72      pages, and such. You can take a look at [[http://karl-voit.at/][Karl Voit]]'s personal web
73      page to see an example result. Great features are planned for the
74      future: auto-tags for article length, overview pages for
75      navigation, extremely easy integration of image files through [[https://github.com/novoid/Memacs/blob/master/docs/memacs_filenametimestamps.org][a
76      memacs module]], and so forth.
78 - [[https://gohugo.io/][Hugo]] :: Hugo fast static blog engine supports Org files natively.
80 - [[https://ox-hugo.scripter.co][ox-hugo]] :: An Org exporter backend that exports to
81      [[https://gohugo.io][Hugo]]/Blackfriday-friendly Markdown, along with Hugo front-matter
82      in TOML or YAML. This package was developed after being aware of
83      the fact that Hugo natively supports parsing Org (but that
84      support is only partial).. read more on [[https://ox-hugo.scripter.co/doc/why-ox-hugo/][Why =ox-hugo=?]]
86      =ox-hugo= enables writing posts for Hugo in *native Org mode*. It
87      allows converting your existing Org files to blog posts with
88      almost no modification. Two common Org blogging flows are
89      supported:
90   - Exporting multiple Org sub-trees from a single file to multiple
91     Hugo posts. With this feature, one can produce a whole web site
92     from a single Org file (the [[https://ox-hugo.scripter.co][=ox-hugo= documentation site]] is one
93     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
94     leverages Org tag and property inheritance, and much more!
95   - Exporting a single Org file to a single Hugo post.
97   See the package's website for complete documentation, and the [[https://ox-hugo.scripter.co/test/][test
98   site]] [[[https://github.com/kaushalmodi/ox-hugo/tree/master/test/site/content-org][source]]] for hundreds of test cases and feature
99   demonstrations.
101 * Wiki tools
103 - [[http://ikiwiki.info/][ikiwiki]] is a web site compiler written in Perl.  In many ways it is
104   similar to Jekyll, but has closer integration with version control
105   systems.  It supports blogging and has many plugins.
107   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
108   org and converts them to html suitable for processing by ikiwiki.
110   There is [[https://github.com/chrismgray/ikiwiki-org-plugin][another plugin]] by Chris Gray that interprets org files.  It
111   is still under intermittent development, but is stable enough for
112   general use.
114 - [[https://github.com/eschulte/org-ehtml][Org-ehtml]] defines an editable HTML backend for the new exporting
115   engine.  Org-ehtml runs on an [[https://github.com/eschulte/emacs-web-server][Emacs web server]].  Exported Org-mode
116   web pages may be edited through a web browser, the edits may then be
117   saved to Org-mode files on the computer running the server, and may
118   even be committed to a version control system (experimental)
119   providing wiki functionality.  There is also experimental support
120   for password authentication.  Also see the [[http://article.gmane.org/gmane.emacs.orgmode/58773][initial announcement
121   email on the Org-mode mailing list]].
123 * Other tools
125 - [[file:org-tutorials/org-ruby.org][org-ruby]] is a Ruby gem for converting org-mode files to HTML. The goal is
126   to make it easier to use org-mode files in website tools like [[http://webby.rubyforge.org/][Webby]],
127   [[http://jekyllrb.com/][Jekyll]], or [[http://webgen.rubyforge.org/][webgen]].
129 * More links
131 - [[http://emacs-fu.blogspot.com/2009/05/writing-and-blogging-with-org-mode.html][Writing and blogging with org-mode]]
132 - [[http://blog.herraiz.org/archives/241][Using Emacs org-mode for web publishing]]