Developing the website of Pluggable Transports software

Two important links first:

Development repository: https://github.com/Pluggable-Transports/Pluggable-Transports-software/
Deployment URL: https://software.pluggabletransports.info/

In this section some hints for developing this index from the server site are given.

The whole index is a static website generated by bundler and Jekyll and hosted on GitHub pages.
There is no limitation to host the generated static pages on any other arbitrary webserver.

Build the static websites with bundler/Jekyll:

git clone https://github.com/Pluggable-Transports/Pluggable-Transports-software
cd packages
bundle install
bundle exec jekyll build

and copy the content of the generated _site directory to the webserver of your choice.

Basically, there are two layouts. One for the package index _layouts/package_index.html (used by assets/index.md) and one for the individual packages pages _layouts/package.html (used by all .md files in the package directory).
The index read by package_index_resolve() is generated from packages/index.md.
The package index page uses following JavaScript/CSS frameworks:
- FontAwesome for awesome fonts.
- bootstrap: for simply good-looking design.
- DataTables for a dynamic search feature. Configuration at https://datatables.net/download/index:
```
Styling framework
  [x] DataTables
Packages
  [x] DataTables
Extensions
  [x] Scroller
Download method: CDN
  [x] Minify
  [x] Concatenate
```
  If no JavaScript is available, a static HTML table is displayed.
- jQuery: needed by bootstrap and DataTables.
The individual package pages are generated by filling the layout with the metadata given in YAML format, as described in CONTRIBUTING.md.

Provide feedback