diff --git a/docs/markdown_docs/css/extra.css b/docs/markdown_docs/css/extra.css deleted file mode 100644 index ce60f079..00000000 --- a/docs/markdown_docs/css/extra.css +++ /dev/null @@ -1,5 +0,0 @@ -h1#jspsych { text-align: center; font-size: 72px; } - -td, th { - padding: 0.5em; -} \ No newline at end of file diff --git a/docs/markdown_docs/img/folder-setup.png b/docs/markdown_docs/img/folder-setup.png index a0fe22e3..61baf2f3 100644 Binary files a/docs/markdown_docs/img/folder-setup.png and b/docs/markdown_docs/img/folder-setup.png differ diff --git a/docs/markdown_docs/img/folder-with-html.png b/docs/markdown_docs/img/folder-with-html.png index 4d9b3b90..a47878df 100644 Binary files a/docs/markdown_docs/img/folder-with-html.png and b/docs/markdown_docs/img/folder-with-html.png differ diff --git a/docs/markdown_docs/img/jspsych-logo-no-text-mono.svg b/docs/markdown_docs/img/jspsych-logo-no-text-mono.svg new file mode 100644 index 00000000..a9308a90 --- /dev/null +++ b/docs/markdown_docs/img/jspsych-logo-no-text-mono.svg @@ -0,0 +1,493 @@ + + + +image/svg+xml \ No newline at end of file diff --git a/docs/markdown_docs/js/analytics.js b/docs/markdown_docs/js/analytics.js deleted file mode 100644 index 74783689..00000000 --- a/docs/markdown_docs/js/analytics.js +++ /dev/null @@ -1,7 +0,0 @@ -(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) -})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-50563838-1', 'jspsych.org'); - ga('send', 'pageview'); diff --git a/docs/markdown_docs/js/extra.js b/docs/markdown_docs/js/extra.js deleted file mode 100644 index f48d3cea..00000000 --- a/docs/markdown_docs/js/extra.js +++ /dev/null @@ -1 +0,0 @@ -$('table').addClass('table-striped'); \ No newline at end of file diff --git a/docs/markdown_docs/plugins/jspsych-audio-button-response.md b/docs/markdown_docs/plugins/jspsych-audio-button-response.md index 5f054bbe..8c2f1eaf 100644 --- a/docs/markdown_docs/plugins/jspsych-audio-button-response.md +++ b/docs/markdown_docs/plugins/jspsych-audio-button-response.md @@ -20,7 +20,7 @@ trial_duration | numeric | null | How long to wait for the subject to make a res margin_vertical | string | '0px' | Vertical margin of the button(s). margin_horizontal | string | '8px' | Horizontal margin of the button(s). response_ends_trial | boolean | true | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `trial_duration` parameter). If false, then the trial will continue until the value for `timing_response` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. -trial_ends_after_audio | Boolean | false | If true, then the trial will end as soon as the audio file finishes playing. +trial_ends_after_audio | boolean | false | If true, then the trial will end as soon as the audio file finishes playing. ## Data Generated diff --git a/docs/markdown_docs/plugins/jspsych-audio-keyboard-response.md b/docs/markdown_docs/plugins/jspsych-audio-keyboard-response.md index 2bd10c8b..5914416b 100644 --- a/docs/markdown_docs/plugins/jspsych-audio-keyboard-response.md +++ b/docs/markdown_docs/plugins/jspsych-audio-keyboard-response.md @@ -17,7 +17,7 @@ choices | array of keycodes | `jsPsych.ALL_KEYS` | This array contains the keys prompt | string | null | This string can contain HTML markup. Any content here will be displayed below the stimulus. The intention is that it can be used to provide a reminder about the action the subject is supposed to take (e.g., which key to press). trial_duration | numeric | null | How long to wait for the subject to make a response before ending the trial in milliseconds. If the subject fails to make a response before this timer is reached, the subject's response will be recorded as null for the trial and the trial will end. If the value of this parameter is null, then the trial will wait for a response indefinitely. response_ends_trial | boolean | true | If true, then the trial will end whenever the subject makes a response (assuming they make their response before the cutoff specified by the `timing_response` parameter). If false, then the trial will continue until the value for `trial_duration` is reached. You can use this parameter to force the subject to view a stimulus for a fixed amount of time, even if they respond before the time is complete. -trial_ends_after_audio | Boolean | false | If true, then the trial will end as soon as the audio file finishes playing. +trial_ends_after_audio | boolean | false | If true, then the trial will end as soon as the audio file finishes playing. ## Data Generated diff --git a/docs/markdown_docs/plugins/jspsych-iat-html.md b/docs/markdown_docs/plugins/jspsych-iat-html.md index bc81fa67..f4345fc1 100644 --- a/docs/markdown_docs/plugins/jspsych-iat-html.md +++ b/docs/markdown_docs/plugins/jspsych-iat-html.md @@ -31,7 +31,7 @@ Name | Type | Value stimulus | string | Either the path to the image file or the string containing the HTML formatted content that the subject saw on this trial. key_press | numeric | Indicates which key the subject pressed. The value is the [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) corresponding to the subject's response. rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response. -correct | boolean | Boolean of whether the user's key press was correct for the given image or incorrect. +correct | boolean | boolean of whether the user's key press was correct for the given image or incorrect. ## Examples diff --git a/docs/markdown_docs/plugins/jspsych-iat-image.md b/docs/markdown_docs/plugins/jspsych-iat-image.md index 26c060d9..33ae5f4b 100644 --- a/docs/markdown_docs/plugins/jspsych-iat-image.md +++ b/docs/markdown_docs/plugins/jspsych-iat-image.md @@ -31,7 +31,7 @@ Name | Type | Value stimulus | string | Either the path to the image file or the string containing the HTML formatted content that the subject saw on this trial. key_press | numeric | Indicates which key the subject pressed. The value is the [numeric key code](http://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes) corresponding to the subject's response. rt | numeric | The response time in milliseconds for the subject to make a response. The time is measured from when the stimulus first appears on the screen until the subject's response. -correct | boolean | Boolean of whether the user's key press was correct for the given image or incorrect. +correct | boolean | boolean of whether the user's key press was correct for the given image or incorrect. ## Examples diff --git a/docs/markdown_docs/tutorials/hello-world.md b/docs/markdown_docs/tutorials/hello-world.md index 1d2d34e7..05980158 100644 --- a/docs/markdown_docs/tutorials/hello-world.md +++ b/docs/markdown_docs/tutorials/hello-world.md @@ -6,23 +6,23 @@ In the long tradition of **"Hello world!"** examples, this tutorial creates an e Start by downloading the jsPsych library. The most recent version can always be found on the [GitHub releases page](https://github.com/jodeleeuw/jsPsych/releases). -*Note: the images below show version 4.2, but the process is the same for the most recent version.* +*Note: the image below shows version 4.2, but the process is the same for the most recent version.* ![releasespage](/img/githubreleases.jpg) ## Step 2: Create a folder to store your experiment files -Create a folder on your computer to put the experiment files in. Once you've created the folder, open the downloaded archive from step 1, and move the extracted folder (called `jspsych-6.0` if using v6.0 of jsPsych) into the experiment folder. Here's what it looks like on a Mac: +Create a folder on your computer to put the experiment files in. Once you've created the folder, open the downloaded archive from step 1, and move the extracted folder (called `jspsych-6.0` if using v6.0 of jsPsych) into the experiment folder. Here's what it looks like on a Windows machine: ![folder setup](/img/folder-setup.png) ## Step 3: Create a new HTML file -To edit jsPsych code, you'll need a programming-friendly text editor. Some free options are: +To edit jsPsych code you'll need a programming-friendly text editor. Some free options are: -* [Atom](https://atom.io) (Windows & Mac OSX) +* [Atom](https://atom.io) (Windows, OSX, Linux) * [Notepad++](http://notepad-plus-plus.org/) (Windows) -* [TextMate](http://macromates.com/) (Mac OSX) +* [TextMate](http://macromates.com/) (OSX) Once you've got a text editor that you like, create a new file in the experiment folder called `experiment.html` diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a7f04a09..018ece6d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,12 +1,21 @@ site_name: jsPsych -theme: readthedocs -repo_url: 'https://github.com/jodeleeuw/jsPsych' -repo_name: 'GitHub' -extra_css: -- css/extra.css -extra_javascript: -- js/extra.js -- js/analytics.js +theme: + name: 'material' + palette: + primary: 'green' + accent: 'orange' + logo: 'img/jspsych-logo-no-text-mono.svg' +google_analytics: + - 'UA-50563838-1' + - 'auto' +markdown_extensions: + - admonition + - codehilite: + guess_lang: false + - toc: + permalink: true +repo_url: 'https://github.com/jspsych/jsPsych' +repo_name: 'jspsych/jspsych' docs_dir: markdown_docs pages: - Introduction: 'index.md'