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