Skip to content

README.rst

Latest commit

 

History

History
45 lines (33 loc) · 1.56 KB

README.rst

File metadata and controls

45 lines (33 loc) · 1.56 KB

Paylogic developer portal

This repository contains the sources for the Paylogic developer portal hosted at developer.paylogic.com. We use the static site generator Pelican to generate the web pages from content written in the reStructuredText format.

The git repository is hosted on our GitHub account and we use GitHub Pages with a custom DNS name for hosting.

Running it locally

To run the developer portal locally (e.g. to easily preview changes) the following steps should help you get started:

# Clone the git repository.
git clone git@github.com:paylogic/developer.paylogic.com.git

# Run Pelican and view the result in a web browser.
cd developer.paylogic.com
make devserver [DEVSERVER_PORT=<port>]
xdg-open http://127.0.0.1:8000  # DEVSERVER_PORT is 8000 by default

Publishing changes

The makefile target make github will render the website and store the rendered files into the gh-pages branch which is what GitHub Pages deploys to developer.paylogic.com.

License

This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.