Giter VIP home page Giter VIP logo

xmpp.org's Introduction

xmpp.org

Build Status

Please log any issues.

Any editorial questions: Laura Gill or Simon Tennant can help

Contributing new content and updates

  • 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.

Communication forum

Please use [email protected] for discussions about the site, content, generation etc.

Site generation

Software Requirements

  • Pelican 3.3
  • ghp-import
  • Markdown 2.3.1

Gentle introduction to Pelican

Pelican's QUICKSTART page is a good place to learn about the basics of Pelican (installation, project skeleton, development cycle, etc.).

Installation instructions

Two types of installations are documented: a regular one, and one that creates a virtual environment via Vagrant.

Regular installation

To run a development server on your local computer, follow these basic steps:

git clone ssh://[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://localhost:8000

Vagrant-based installation

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://[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://localhost:8000

Configuration

<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>

Site generation

To just generate a new version (without starting up a local webserver) just do:

make html

Theme development

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.

xmpp.org's People

Contributors

sockdrawermoney avatar dondebonair avatar bear avatar guusdk avatar intosi avatar hlapp avatar horazont avatar tfar avatar peterwaher avatar lauracrossley avatar imaginator avatar agnauck avatar ge0rg avatar nyco avatar stpeter avatar xnyhps avatar magnunleno avatar lloydwatkin avatar guilhermesgb avatar kev avatar linkmauve avatar marlboromoo avatar samwhited avatar pgstath avatar edhelas avatar chdoig avatar kousu avatar ben-rockliffe avatar toumorokoshi avatar sonnyp avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.