README.org 2.74 KB
Newer Older
Rasmus's avatar
Rasmus committed
1
2
3
4
#+title: Publishing org-mode projects on Gitlab Pages
#+author: Rasmus
#+date: <2016-05-23 Mon>

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
5
Example [[http://orgmode.org][org-mode]] website using [[http://pages.gitlab.io/][GitLab Pages]].
Rasmus's avatar
Rasmus committed
6
7

Learn more about GitLab Pages at [[https://pages.gitlab.io]] and the
8
official documentation [[https://docs.gitlab.com/ce/user/project/pages/]].
Rasmus's avatar
Rasmus committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

* Org-mode
Org-mode is [[http://www.gnu.org/philosophy/free-sw.en.html][Free Software]] and part of [[https://www.gnu.org/s/emacs/][GNU Emacs]].  It's a simple
document format ("Org") with a powerful and intuitive interface
(org-mode) that can [[http://orgmode.org/org.html#Exporting][export]] and [[http://orgmode.org/org.html#Publishing][publish]] to html, LaTeX, ascii, odt
amongst others, and [[http://orgmode.org/org.html#Working-with-source-code][evaluate source code]].

The org-mode manual can be accessed here: [[http://orgmode.org/org.html]].

The main place for Org development is the mailing list, available on
[[http://dir.gmane.org/gmane.emacs.orgmode][Gmane]].
* Gitlab CI

This project's static Pages are built by [[https://about.gitlab.com/gitlab-ci/][GitLab CI]], following the
steps defined in [[https://gitlab.com/pages/nikola/blob/master/.gitlab-ci.yml][.gitlab-ci.yml]]:

#+BEGIN_SRC conf
image: moul/emacs

pages:
  script:
  - emacs --batch --eval "(progn (package-initialize) (package-refresh-contents) (package-install 'org))"
  - emacs --batch --no-init-file --load publish.el --funcall org-publish-all
  artifacts:
    paths:
    - public
  only:
  - master
#+END_SRC

These build instructions are using a docker image, namely ~moul/emacs~.
It makes it possible to publish the project on a public runner on
Gitlab.com.

You could probably get a better experience by using a local runner on
a server you control.  If so, you can drop the ~image~ keyword.

* Building locally
Org-mode is part of GNU Emacs.  See how to obtain GNU Emacs on your OS
here: [[https://www.gnu.org/software/emacs/download.html]].

To get the latest version of Org see [[http://orgmode.org]].

* GitLab User or Group Pages

To use this project as your user/group website, you will need one
additional step: just rename your project to ~namespace.gitlab.io~,
where ~namespace~ is your ~username~ or ~groupname~. This can be done by
navigating to your project's Settings.

59
Read more about [[https://docs.gitlab.com/ce/user/project/pages/#user-or-group-pages][user/group Pages]] and [[https://docs.gitlab.com/ce/user/project/pages/#project-pages][project Pages]].
Rasmus's avatar
Rasmus committed
60
61
62
63
64
65

* Did you fork this project?

If you forked this project for your own use, please go to your
project's Settings and remove the forking relationship, which won't be
necessary unless you want to contribute back to the upstream project.
Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
66
67
68

---

Achilleas Pipinellis's avatar
Achilleas Pipinellis committed
69
Forked from [[https://gitlab.com/pank/org-mode-gitlab-pages]]