Please log any issues.
Any editorial questions: Laura Gill or Simon Tennant can help
- Fork the code to your own git repository.
- Make your changes in
/content/pages
or directly in GitHub. - When you are happy with your updates, submit a pull request describing the changes.
- IMPORTANT :- Before sending a Pull Request make sure that your forked repo is in sync with the base repo.
- The updates will be reviewed and merged in.
Please use [email protected] for discussions about the site, content, generation etc.
- Commits to the master branch generate a new build.
- Builds are visible at https://travis-ci.org/xsf/xmpp.org/builds
- New content is deployed to gh-pages branch
- and visible on http:https://new.xmpp.org
- Pelican 3.3
- ghp-import
- Markdown 2.3.1
Pelican's QUICKSTART page is a good place to learn about the basics of Pelican (installation, project skeleton, development cycle, etc.).
Two types of installations are documented: a regular one, and one that creates a virtual environment via Vagrant.
To run a development server on your local computer, follow these basic steps:
git clone ssh:https://[email protected]/xsf/xmpp.org.git
# install Pelican and dependencies
cd xmpp.org
Running the server in development mode:
make serve
If you want the server to autoreload whenever a file change, you can instead do:
make devserver
View at http:https://localhost:8000
For your convenience, this repository ships with a basic Vagrantfile, which allows you to create virtual machine with all the dependencies required for local development.
Assuming your computer has Vagrant installed, the following will get you a running server:
git clone ssh:https://[email protected]/xsf/xmpp.org.git
cd xmpp.org
vagrant up
vagrant ssh
cd /vagrant/
make devserver
Now, the wesite should be available at http:https://localhost:8000
<repo>
fabfile.py
develop_server.sh
Makefile
README.md
pelicanconf.py (development configuration)
publishconf.py (production configuration)
output
<generated files - published to gh-pages branch>
content
pages
<website page files>
pelican-bootstrap3
<website theme>
To just generate a new version (without starting up a local webserver) just do:
make html
You can modify the theme (layout and styling) in the xmpp.org-theme directory.
Make changes to Sass files, not compiled CSS.
npm i
then run grunt
to compile Sass.