Initial docs

Author: effigies

docs/_static/BIDS_black.svg

@@ -13,7 +13,11 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = [
+    # 'sphinx_js',
+    'myst_parser',
+    'sphinx_copybutton',
+]
 
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
@@ -23,5 +27,22 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+html_theme = 'pydata_sphinx_theme'
 html_static_path = ['_static']
+
+html_theme_options = {
+    "logo": {
+        "text": "BIDS Validator",
+        "image_light": "_static/BIDS_black.svg",
+        "image_dark": "_static/BIDS_white.svg",
+    }
+}
+
+# -- Customization
+# js_language = 'typescript'
+# js_source_path = '../src/**/*.ts'
+# primary_domain = 'js'
+
+myst_enable_extensions = [
+    "attrs_inline",
+]

docs/_static/BIDS_white.svg

@@ -0,0 +1,39 @@
+# The BIDS Validator
+
+The BIDS Validator is a web application, command-line utility,
+and Javascript/Typescript library for assessing compliance with the
+[Brain Imaging Data Structure][BIDS] standard.
+
+## Getting Started
+
+In most cases,
+the simplest way to use the validator is to browse to the [BIDS Validator][] web page:
+
+![The web interface to the BIDS Validator with the "Select Dataset Files" button highlighted.
+(Dark theme)](_static/web_entrypoint_dark.png){.only-dark width="50%" align=center}
+![The web interface to the BIDS Validator with the "Select Dataset Files" button highlighted.
+(Light theme)](_static/web_entrypoint_light.png){.only-light width="50%" align=center}
+
+The web validator runs in-browser, and does not transfer data to any remote server.
+
+In some contexts, such as when working on a remote server,
+it may be easier to use the command-line. 
+The BIDS Validator can be run with the [Deno] runtime
+(see [Deno - Installation][] for detailed installation instructions):
+
+```shell
+deno run -A jsr:@bids/validator
+```
+
+```{toctree}
+:maxdepth: 2
+:caption: Contents:
+
+API Reference <https://jsr.io/@bids/validator/doc>
+```
+
+
+[BIDS]: https://bids.neuroimaging.io
+[BIDS Validator]: https://bids-standard.github.io/bids-validator/
+[Deno]: https://deno.com/
+[Deno - Installation]: https://docs.deno.com/runtime/getting_started/installation/

docs/_static/web_entrypoint_dark.png

@@ -0,0 +1,4 @@
+sphinx
+myst_parser
+pydata-sphinx-theme
+sphinx-copybutton