An open API service indexing awesome lists of open source software.

https://github.com/paylogic/developer.paylogic.com

The sources for the Paylogic development portal
https://github.com/paylogic/developer.paylogic.com

Last synced: 4 months ago
JSON representation

The sources for the Paylogic development portal

Awesome Lists containing this project

README

          

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=]
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`_.

.. External references:
.. _Creative Commons Attribution-ShareAlike 3.0 Unported License: http://creativecommons.org/licenses/by-sa/3.0/
.. _developer.paylogic.com: http://developer.paylogic.com/
.. _GitHub Pages: http://pages.github.com/
.. _GitHub: https://github.com/paylogic
.. _Pelican: http://docs.getpelican.com/en/3.2/getting_started.html
.. _reStructuredText: http://docutils.sourceforge.net/rst.html