Skip to content

lloydwatkin/xep-builder

Repository files navigation

XEP Builder

A XEP building tool that allows you to break the XEP document down into smaller, more manageable sections. A grunt task will also attempt to rebuild the XEP on every file change and build the resulting html.

When linked up with travis (see below) the library can also publish XEPs to your github pages branch and test any pull requests that are made to the repository.

See it being used "fo' realz"™ at https://github.com/buddycloud/buddycloud-xep.

Creating

Put your sections in the sections subdirectory. They will be added to the XEP in numerical order when build, e.g.

  • 0-introduction.xml
  • 1-security.xml
  • 3-examples.xml

Building the XEP

Manually

make
open index.html

or

grunt build

Automatically on file change

npm install -g grunt-cli
npm i .
grunt

A task will now monitor the file system and rebuild the XEP on changes.

Deploy to gh-pages using Travis CI

Build status

Build Status

About

A tool to help with writing/building XEPS

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published