Skip to content

This contains the content hosted on the FieldTrip website

License

Notifications You must be signed in to change notification settings

fieldtrip/website

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

412f9e2 · Feb 7, 2024
Sep 18, 2023
Feb 3, 2024
Jan 19, 2024
Aug 22, 2023
Feb 1, 2024
Aug 31, 2023
Feb 6, 2024
Apr 12, 2023
Feb 1, 2024
Mar 20, 2022
Jan 17, 2024
Jan 22, 2024
Jan 19, 2024
Jan 25, 2024
Dec 15, 2023
Feb 7, 2024
Oct 30, 2019
Feb 1, 2024
Aug 20, 2023
Mar 20, 2022
Aug 20, 2023
Feb 18, 2020
Mar 2, 2020
Oct 7, 2020
Aug 22, 2023
May 28, 2022
Oct 26, 2018
Oct 6, 2022
Jan 25, 2024
Aug 20, 2023
Aug 24, 2023
Aug 20, 2023
Mar 20, 2022
Dec 1, 2023
Mar 8, 2023
Aug 31, 2023
Jan 19, 2024
Mar 20, 2022
Mar 8, 2023
Aug 20, 2023
Mar 3, 2020
Mar 20, 2022
Aug 31, 2023
Aug 31, 2023
Nov 19, 2018
Mar 15, 2019
Oct 26, 2018
Jan 9, 2023
Aug 31, 2023
Jan 19, 2024
Jul 21, 2022
Aug 31, 2023
Jan 25, 2024

Repository files navigation

FieldTrip website

This repository contains the FieldTrip documentation hosted on https://www.fieldtriptoolbox.org.

Feel free to contribute by doing edits here and sending a pull request. See https://www.fieldtriptoolbox.org/development/git for a complete tutorial and https://www.fieldtriptoolbox.org/development/guideline/website for formatting instructions.

Technical notes

Limitations when viewing on GitHub

Most of the Markdown formatting will show up nicely here on GitHub, but there are some limitations.

  • Hyperlinks will not be pointing to the correct pages.
  • Images are not included correctly.
  • YouTube videos will not be included correctly.
  • Highlighted sections will not show correctly.
  • Code blocks don't have syntax highlighting.

Evaluating the website locally

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.

Checking for broken links and missing images

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

House prose style

  • UK English spelling
  • No Oxford commas
  • Spellings
    • "open source", not "open-source"
    • "website", not "web site"
    • "MATLAB", not "Matlab"
  • Sentence case (not "Title Case") for section headings
  • Use en- or em-dashes where appropriate