TAXII Documentation

This is the TAXII documentation source code repository.

Work in progress: The TAXII documentation is a work in progress.

Installation

1. Install Ruby 1.9.3 or higher for your platform (if it isn't already installed).
2. Install the bundler gem: gem install bundler
3. Install the dependencies via bundler: bundle install
4. Run the server with jekyll server or a static build with jekyll build

Note: Jekyll has some "issues" on Windows. See: Jekyll on Windows for instructions. The issues I encountered (other than those covered in those instructions) were:

• You'll need to install jekyll version 1.4.2:

gem uninstall jekyll # If you already installed it
gem install jekyll --version "=1.4.2"

• You'll need to install pygments version 0.5.0:

gem uninstall pygments.rb
gem install pygments.rb --version "=0.5.0"

If you run into any problems on other platforms, see the Jekyll Installation Docs. In particular, you'll need to be able to compile native code so on OS X you'll need the Xcode Command Line tools and on Linux you'll need the appropriate build packages (build-essential on Ubuntu, etc).

Contributing

The TAXII Project welcomes contributions to our documentation repository. If you have a change you want to make:

1. Fork this repository
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

You can also speak to the TAXII team by e-mailing taxii@mitre.org and we can make the change for you.