summaryrefslogtreecommitdiffstats
path: root/site/projects/org-blog.org
diff options
context:
space:
mode:
Diffstat (limited to 'site/projects/org-blog.org')
-rw-r--r--site/projects/org-blog.org128
1 files changed, 74 insertions, 54 deletions
diff --git a/site/projects/org-blog.org b/site/projects/org-blog.org
index 251e877..989593b 100644
--- a/site/projects/org-blog.org
+++ b/site/projects/org-blog.org
@@ -1,11 +1,19 @@
#+TITLE: git-auto-commit-mode
#+LINK_UP: ../index.html
-#+LINK_HOME: ../index.html
+#+LINK_HOME: http://ryuslash.org
#+LINK: src https://github.com/ryuslash/org-blog
#+LINK: tar_gz https://github.com/ryuslash/org-blog/tarball/master
#+LINK: zip https://github.com/ryuslash/org-blog/zipball/master
+#+STARTUP: showall
+
+#+begin_html
+ <script src="/keyjs.KS" type="text/javascript"></script>
+ <script type="text/javascript">
+ keyjs_initialize({ "u": [ "keyjs_goto", "../index.html" ],
+ "h": [ "keyjs_goto", "http://ryuslash.org" ] });
+ </script>
+#+end_html
-#+INCLUDE: "../header.org" :lines "1-4"
#+INCLUDE: "dlmenu.inc"
* About
@@ -16,68 +24,80 @@
viable/acceptable pure-org solution for me, so I'm trying to revive
it.
-** Why
-
- As stated, it seemed to be out-of-date and packages like [[http://renard.github.com/o-blog/][o-blog]] and
- [[http://www.emacswiki.org/emacs/Blorg][blorg]] didn't work for me, and many others require some external
- tool to work.
-
-* Setup
-
- Since I've adapted it to work as a normal publishing function for
- org, setting it up is a lot like any other publishing project as
- well:
-
- #+BEGIN_SRC emacs-lisp
- (setq org-publish-project-alist
- '(("myblog"
- :base-directory "~/location/to/org/files/"
- :publishing-directory "/place/to/export/to/"
- :base-extension "org"
- :publishing-function org-publish-org-to-blog
- :blog-title "some title"
- :blog-description "some description"
- :blog-export-rss t
- :index-title "oni blog"
- :recursive nil
- :table-of-contents nil)))
- #+END_SRC
+** Features
+
+ - Pure ~org-mode~, all you need is some setup and you can use it like
+ any other exporting function.
+ - Separate drafts from posts.
+ - Generate an index of posts.
+ - Rudimentary RSS support.
+
+** Requirements
+
+ - GNU Emacs
+ - ~org-mode~
+
+* Usage
- Most of these options are very normal project settings and can be
- read about in the documentation for the variable
- ~org-publish-project-alist~. The ~blog-title~, ~blog-description~,
- ~blog-export-rss~ and ~index-title~, however, are used by
- ~org-blog~.
+** Setup
- - ~blog-title~
+ Since I've adapted it to work as a normal publishing function for
+ org, setting it up is a lot like any other publishing project:
- This setting is used when exporting RSS. It sets the ~title~ in
- the XML output.
+ #+BEGIN_SRC emacs-lisp
+ (setq org-publish-project-alist
+ '(("my-blog"
+ :base-directory "~/location/to/org/files/"
+ :publishing-directory "/place/to/export/to/"
+ :base-extension "org"
+ :publishing-function org-publish-org-to-blog
+ :blog-title "some title"
+ :blog-description "some description"
+ :blog-export-rss t
+ :index-title "oni blog"
+ :recursive nil
+ :table-of-contents nil)))
+ #+END_SRC
- - ~blog-description~
+ Most of these options are very normal project settings and can be
+ read about in the documentation for the variable
+ ~org-publish-project-alist~. The ~blog-title~, ~blog-description~,
+ ~blog-export-rss~ and ~index-title~, however, are used by ~org-blog~.
- This setting is also used when exporting RSS. It sets the
- ~description~ in the XML output.
+ - ~blog-title~ :: This setting is used when exporting RSS. It sets the
+ ~title~ in the XML output.
- - ~blog-export-rss~
+ - ~blog-description~ :: This setting is also used when exporting
+ RSS. It sets the ~description~ in the XML output.
+
+ - ~blog-export-rss~ :: Whether or not you would like an RSS feed to be
+ exported.
+
+ - ~index-title~ :: This is used as the title of the blog's index page.
+
+ Apart from these there are also 2 other settings that need your
+ attention:
+
+ #+BEGIN_SRC emacs-lisp
+ (setq org-blog-directory "~/path/to/blog/org/files/")
+ (setq org-blog-unfinished-directory "~/path/to/drafts/")
+ #+END_SRC
- Whether or not you would like an RSS feed to be exported.
+ These don't have any relevance to the exporting and publishing
+ functions, but they're used by the ~org-blog-new-post~ and
+ ~org-blog-finish-post~ functions, which help with creating new posts.
- - ~index-title~
+** Create new post
- This is used as the title of the blog's index page.
+ To create a new post, just call =M-x org-blog-new-post= and start
+ writing.
- Apart from these there are also 2 other settings that need your
- attention:
+** Finish a post
- #+BEGIN_SRC emacs-lisp
- (setq org-blog-directory "~/path/to/blog/org/files/")
- (setq org-blog-unfinished-directory "~/path/to/drafts/")
- #+END_SRC
+ When you're done writing and would like to set it up to be
+ published, just call =M-x org-blog-finish-post=.
- These don't have any relevance to the exporting and publishing
- functions, but they're used by the ~org-blog-new-post~ and
- ~org-blog-finish-post~ functions, which help with creating new
- posts.
+** Publish
-#+INCLUDE: "../header.org" :lines "5-8"
+ To publish just use any of the ~org-publish-*~ functions as you would
+ any other org site.