mirror of
https://gitlab.com/openlp/website.git
synced 2024-12-22 04:52:49 +00:00
Fix some small issues and add a README.rst file.
bzr-revno: 11
This commit is contained in:
commit
2b0b5601e4
46
README.rst
Normal file
46
README.rst
Normal file
@ -0,0 +1,46 @@
|
||||
==============
|
||||
OpenLP Website
|
||||
==============
|
||||
|
||||
This repository holds the OpenLP website, so that anyone can contribute to the site.
|
||||
|
||||
The website is built using Nikola, the static site generator. It uses Disqus for comments, which has superior
|
||||
spam detection and moderation tools. The instructions below show you how to get set up on your local machine.
|
||||
|
||||
Installing Nikola
|
||||
-----------------
|
||||
The OpenLP site is built on **Nikola** 7.6.x. This means you'll probably need to install it in a virtual environment.
|
||||
Not to worry, this is pretty simple.
|
||||
|
||||
First up, install the ``python-virtualenv`` package::
|
||||
|
||||
$ sudo apt-get install python-virtualenv
|
||||
|
||||
Now create a virtual environment somewhere. I usually put it in the same directory as my Bazaar repositories::
|
||||
|
||||
$ virtualenv venv
|
||||
|
||||
Once that has been created, you can install Nikola with ``pip``::
|
||||
|
||||
$ cd venv/bin
|
||||
$ ./pip install --upgrade nikola
|
||||
|
||||
*Note: I'm using ``--upgrade`` to make sure that I install the latest version of Nikola, so that even if I have a version of Nikola installed, I'll have the latest and greatest here.*
|
||||
|
||||
I like to symlink the ``nikola`` binary into the project directory I'm working in, for ease of use::
|
||||
|
||||
$ cd ~/projects/openlp/website
|
||||
$ ln -s ~/venv/bin/nikola nikola
|
||||
|
||||
Now you're ready to start working on the web site. Next step is to build the site::
|
||||
|
||||
$ nikola build
|
||||
|
||||
That will run through a whole bunch of stuff and build the site for you. To run the site, simply use the ``serve``
|
||||
command::
|
||||
|
||||
$ nikola serve
|
||||
|
||||
This will start a local Python web server and tell you where to go in your browser in order to preview the site.
|
||||
|
||||
Once you're this far, you'll be ready to start contributing toward the we site. Have fun!
|
2
conf.py
2
conf.py
@ -265,6 +265,8 @@ URL_TYPE = 'full_path'
|
||||
# often removed or replaced as well.
|
||||
# SLUG_TAG_PATH = True
|
||||
|
||||
WRITE_TAG_CLOUD = False
|
||||
|
||||
# A list of redirection tuples, [("foo/from.html", "/bar/to.html")].
|
||||
#
|
||||
# A HTML file will be created in output/foo/from.html that redirects
|
||||
|
@ -359,7 +359,7 @@
|
||||
<h3 class="media-heading">Great Product!</h3>
|
||||
<blockquote>
|
||||
<p>Sunday morning I set the up projector, gave a 10 minute lesson to the young lady who does our overheads. Everything went smoothly. She was so excited, the congregation thought it was great, our priest was ecstatic.</p>
|
||||
<footer>Someone famous in <cite title="Source Title">Source Title</cite></footer>
|
||||
<footer>John H. <cite title="Saint Patrick's RC Church in Caledonia, Ontario, Canada">St Patrick's Church, Canada</cite></footer>
|
||||
</blockquote>
|
||||
</div>
|
||||
</div>
|
||||
|
Loading…
Reference in New Issue
Block a user