Skip to content

Commit

Permalink
version 0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
sillykelvin committed Sep 3, 2013
1 parent abc69f4 commit 5bdcd83
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 30 deletions.
30 changes: 15 additions & 15 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@
2) incremental publication (according to =git diff= command)
3) category support
4) tags support (auto generated)
5) search engine support (auto generated)
6) a beautiful theme
7) theme customization support
8) commenting (implemented using disqus)
9) site visiting tracking (implemented using google analytics)
10) index/about page support (auto generated if no default provided)
11) highly customizable
5) RSS support (auto generated)
6) search engine support (auto generated)
7) a beautiful theme
8) theme customization support
9) commenting (implemented using disqus)
10) site visiting tracking (implemented using google analytics)
11) index/about page support (auto generated if no default provided)
12) highly customizable

*[[http://kelvinh.github.com][Here]] is my personal site generated by org-page. The html files and org source files are located at [[https://github.com/kelvinh/kelvinh.github.com]], if you want to give org-page a try, you could take them as example.*

Expand All @@ -35,26 +36,25 @@

* Usage

*Here is a general introduction about how to use org-page, for more detailed introduction and configuration, please have a look in the "doc" folder.*
*Here is a general introduction about how to use org-page, for more detailed introduction and configuration, please see "quick-guide.org" in "doc" folder.*

** installation

Org-page depends on =mustache.el=, so make sure you installed it before you install =org-page=. (the recommended way is to install it trhough emacs' package management system)

After you installed =mustache.el=, clone the repo from github:

: git clone http://github.com/kelvinh/org-page.git
Org-page is now available in the famous emacs package repo [[http://melpa.milkbox.net/][melpa]], so the recommended way is to install it trhough emacs' package management system, for more info about installation, please see *quick-guide.org* in "doc" folder.

** configuration

add following lines into your =.emacs= file:

: ;;; the following is only needed if you install org-page manually
: (add-to-list 'load-path "path/to/org-page")
:
: (require 'org-page)
: (setq op/repository-directory "path/to/your/org/repository")
: (setq op/site-domain "http://your.personal.site.com/")
: (setq op/personal-disqus-shortname "your_disqus_shortname")
: ;;; the three configurations below are optional
:
: ;;; the configuration below are optional
: (setq op/personal-google-analytics-id "your_google_analytics_id")

** publication
Expand All @@ -76,9 +76,9 @@
3. [[http://git-scm.com][git]]: a free and open source version control system
4. [[https://github.com/Wilfred/mustache.el][mustache.el]]: a mustache templating library for Emacs
5. [[http://fly.srk.fer.hr/~hniksic/emacs/htmlize.el.cgi][htmlize.el]]: a library for syntax highlighting (usually this library is shipped with emacs)
6. [[https://github.com/magnars/dash.el][dash.el]]: a modern list library for Emacs

* Known issues

- Currently the RSS feature has not been implemented, so the RSS link is unavailable.
- Currently the deletion change handler has not been implemented, so if you deleted some org sources, you may have to manually delete corresponding html files generated.
- URI path change detection is not available, that is, if you make a post with URI "/blog/2013/03/25/the-old-post-name", then you changed it in your org source (with new value of =#+URI= property), org-page is unable to detect this kind of change, it will only publish a new html file for you, so you need to delete the old html file related to the old URI manually.
7 changes: 7 additions & 0 deletions doc/changelog.org
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
#+DATE: 2013-08-24 Sat


* v0.5

- Implemented RSS feature.
- Introduced *dash* to manipulate lists.
- Improved several functions.
- Updated docs.

* v0.41

- Added to melpa.
Expand Down
24 changes: 20 additions & 4 deletions doc/quick-guide.org
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,33 @@

* Installation

Currently org-page has not been added to any elpa repos yet, so you could install org-page through cloning git repository:
** The manual way (NOT recommended)

: git clone https://github.com/kelvinh/org-page.it
To install org-page manually, you should first install all depended libraries listed in *README.org*, then, clone the repo:

The installation now is done.
: git clone https://github.com/kelvinh/org-page.it

After that, please remember to add the path to your emacs' =load-path= variable so that emacs could find this package.

** Through package management system (strongly recommended)

If you have never used emacs' package management system before, just add the following to your =init.el=:

: (require 'package)
: (package-initialize)
: (add-to-list 'package-archives
: '("melpa" . "http://melpa.milkbox.net/packages/") t)

Now you could install org-page using the following command:

: M-x package-install org-page

* Configuration

The *required configuration* of org-page is very little, as below:

: (add-to-list 'load-path "path/to/org-page") ;; add org-page to load-path
: (add-to-list 'load-path "path/to/org-page") ;; add org-page to load-path, only needed if you install org-page manually
:
: (require 'org-page)
: (setq op/repository-directory "path/to/your/org/repository") ;; the repository location
: (setq op/site-domain "http://your.personal.site.com/") ;; your domain
Expand Down
5 changes: 3 additions & 2 deletions org-page-pkg.el
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
(define-package
"org-page" "0.4"
"org-page" "0.5"
"a static site generator based on org mode"
'((ht "1.5")
(mustache "0.22")
(htmlize "1.47")
(org "8")))
(org "8.0")
(dash "2.0.0")))
19 changes: 10 additions & 9 deletions org-page.el
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,17 @@
;; Org-page provides following features:

;; 1) org sources and html files managed by git
;; 2) incremental publication
;; 2) incremental publication (according to =git diff= command)
;; 3) category support
;; 4) tags support (auto generated)
;; 5) search engine support (auto generated)
;; 6) a beautiful theme
;; 7) theme customization support
;; 8) commenting (implemented using disqus)
;; 9) site visiting tracking (implemented using google analytics)
;; 10) index/about page support (auto generated if no default provided)
;; 11) highly customizable
;; 5) RSS support (auto generated)
;; 6) search engine support (auto generated)
;; 7) a beautiful theme
;; 8) theme customization support
;; 9) commenting (implemented using disqus)
;; 10) site visiting tracking (implemented using google analytics)
;; 11) index/about page support (auto generated if no default provided)
;; 12) highly customizable

;;; Code:

Expand All @@ -50,7 +51,7 @@
(require 'op-export)


(defconst org-page-version "0.41")
(defconst org-page-version "0.5")

(defun op/do-publication (&optional force-all
base-git-commit pub-base-dir auto-commit)
Expand Down

0 comments on commit 5bdcd83

Please sign in to comment.