Skip to content

Latest commit

 

History

History
59 lines (37 loc) · 1.73 KB

README.rst

File metadata and controls

59 lines (37 loc) · 1.73 KB

linuxaudio.org

This is the README for http://linuxaudio.org

The website is constructed from
  • a pelican project (all content as reStructuredText in the content folder).
  • 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 (soon)

Getting the content

  • Clone the repository

    git clone https://github.com/linuxaudio/linuxaudio.org
  • Initialize all submodules

    git submodule update --init --recursive

Generating new content

After editing pages or blog posts, re-generate the whole site by doing a simple
pelican
in the root directory of this repository. It will generate the whole website below the output folder.

Testing new content locally

You can easily test your changes locally by starting a simple python HTTP server for the output folder.
cd output
python -m http.server
This will start the web server on your localhost on port 8000, so you can have a look at your modifications.
(You can also use the develop_server.sh script in the root of this repository for this.)

Upload new content to the webserver

Uploading the new content now is as easy as doing a
make rsync_upload
in the root directory of this repository.
This will automatically rsync the output folder with your remote website folder.