vanosg / ircv3.github.io-1

IRCv3 website

IRCv3 Website

This is the IRCv3 website.

Testing

If you want to test your changes to this website locally before submitting a pull request (always a good idea), there are two options: using Bundler, and manual.

After you finish these steps, you will be able to go to http://127.0.0.1:4000/ and view a local copy of the website. As you make changes to your files, they will be reflected on that local copy.

Using Bundler:

1. git clone this repository
2. cd ircv3.github.io/
3. git submodule update --init --recursive
4. bundle install
5. bundle exec jekyll serve

Troubleshooting

If you encounter errors installing nokogiri on macOS Sierra, make sure your XCode tools are up to date:

xcode-select --install

Then configure bundler to use the XCode version of libxml2:

bundle config build.nokogiri --use-system-libraries=true --with-xml2-include=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.12.sdk/usr/include/libxml2

This creates/updates a config file in ~/.bundler/config

Manually

You should make sure your manually installed local versions match that of GitHub Pages:

1. Install Jekyll
2. Install dependencies: gem install jekyll-sitemap jekyll-redirect-from
3. git clone this repository
4. cd ircv3.github.io/
5. git submodule update --init --recursive
6. jekyll serve

Adding New Spec

1. Update the spec submodule. If the spec's a draft, confirm that it has the work-in-progress: true tag in the yaml header of the file.
2. List the spec on _irc/index.md
3. Add the spec to _data/irc_versions.yml - the name here is what's used in the support lists. Look at the hide-if-no-support and hide-on-servers options, they affect how the support tables are generated. Make sure you put it in the right place sorting-wise.
4. Add the spec to _data/specs.yml - the name here is what's used in the registry.
5. Add relevant numerics/capabilities/isupport tokens/... to _data/registry.yml
6. Add the relevant support to the data files!

Licenses

The RSS XML feed template was sourced from the Jekyll RSS Feed Templates repo, and is used under this MIT license:

The MIT License (MIT)

Copyright (c) 2014 George Mandis

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.