GithubHelp home page GithubHelp logo

matsvanes / website Goto Github PK

View Code? Open in Web Editor NEW

This project forked from fieldtrip/website

0.0 2.0 0.0 237.96 MB

This contains the content hosted on the FieldTrip website

Home Page: http://www.fieldtriptoolbox.org

License: Other

Ruby 6.20% HTML 9.87% Shell 21.17% CSS 62.76%

website's Introduction

FieldTrip website

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

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

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

website's People

Contributors

apjanke avatar aranas avatar arnodelorme avatar bmjstau avatar britta-wstnr avatar dependabot[bot] avatar dieloz avatar elshafeh avatar gonaz avatar horschig avatar jona-sassenhagen avatar jpereznavarro avatar kloosterman avatar kristijanarmeni avatar marlenemeyer avatar marzdtu avatar mcvinding avatar mer0mingian avatar mmagnuski avatar robertoostenveld avatar sappelhoff avatar schoffelen avatar simonhomoelle avatar spaak avatar stashly avatar stolkarjen avatar treder avatar virtualmarioe avatar wittonc avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.