This repository contains the content that is hosted on http://www.fieldtriptoolbox.org

Feel free to contribute to the FieldTrip documentation by doing edits here and sending a pull request.

Please note that the markdown documents that are nicely displayed here on github will not have the hyperlinks pointing to the correct pages. The hyperlinks will be conrrect when compiled and deployed on our web server.

• Pages that contain tags must have a title.
• Tags should be in lower case.
• Variables passed in an include must be specified in quotes.
• Code blocks should have an empty line before and after them.
• Shared pages should go in _include/shared.
• MarkDown documentation can be found on https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet.
• Liquid documentation can be found on https://help.shopify.com/en/themes/liquid and https://shopify.github.io/liquid.

If you make changes that you want to evaluate prior to publishing them, you have to install Ruby, Bundler, Jekyll, etc. Subsequently you can do

bundle exec jekyll serve --incremental --livereload

which will convert the markdown into html and serve the complete website on http://localhost:4000.

wget --spider -r -nd -nv -o spider.log http://localhost:4000
grep -B1 'broken link!' spider.log  | grep http > broken.log

• For image resizing we might consider a service like https://www.imgix.com or https://images.weserv.nl.
• Use code highlighting from https://jekyllrb.com/docs/liquid/tags/#code-snippet-highlighting.