aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
blob: 8b9126331189d8fa9eda8e4657f8ae8d4062da3a (plain)
1
2
3
4
5
6
7
8
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
Sleep Map
#########
| This is the README for http://sleepmap.de.
|
| The website is constructed from

* a |pelican| project (all content as reStructuredText, see *reStructuredText_CheatSheet.txt* for help).
* a subset of |pelican-plugins|, which are a submodule of this repository in the folder **pelican-plugins**
* a customized theme - have a look at the **theme** folder

Getting the content
-------------------

* Clone the repository

  .. code:: bash

    git clone git@sleepmap.de:sleepmap.git

* Initialize all submodules

  .. code:: bash

    git submodule update --init --recursive

Generating new content
----------------------
| After editing pages or blog posts, re-generate the whole site by doing a simple

  .. code:: bash

    pelican

| in the root directory of this repository. It will generate the whole website below the **output** folder.

Upload new content
------------------
| Uploading the new content now is as easy as doing a 

  .. code:: bash

    make rsync_upload

| in the root directory of this repository.
| This will automatically rsync the output folder with your remote website folder.



.. |pelican| raw:: html

  <a href="https://getpelican.com" target="_blank">Pelican</a>

.. |pelican-plugins| raw:: html

  <a href="https://github.com/getpelican/pelican-plugins/" target="_blank">Pelican Plugins</a>