This is the multi-page printable view of this section. Click here to print.
Documentation
1 - Designer Guide
Neurodesk Design Style Guide
This style guide provides clear standards to ensure visual consistency across all Neurodesk platforms and materials.
Brand Overview
Neurodesk is a community-oriented open-source solution for neuroimaging analysis with four guiding principles: accessibility, portability, flexibility and, overarchingly, reproducibility. This guide ensures visual consistency across all Neurodesk products and documentation.
Logo Usage
Below are official Neurodesk logos available for download. Please refer to the examples below for acceptable usage.
Acceptable Logo Usage
Use these logos on light or neutral backgrounds.
Simple logo
Inclusivity & Pride logo
Horizontal format logo
Logos for Dark Backgrounds
These logos are optimized for use on dark backgrounds:
Simple logo
Inclusivity & Pride logo
Other Variants
No image
Color Palette
You can download the official Neurodesk color palette file for design use:
Primary Colors
| Color Name | Hex Code | RGB Code | Usage |
|---|---|---|---|
| Seafoam green ◼︎ | #6aa329 | (106, 163, 41) | Primary actions |
Secondary Colors
| Color Name | Hex Code | RGB Code | Usage |
|---|---|---|---|
| Black ◼︎ | #0c0e0a | (5, 8, 2) | Regular text, menu bar |
| Darkest green ◼︎ | #161c10 | (16, 24 6) | Successful selection |
| Muted olive green ◼︎ | #1e2a16 | (26, 41, 10) | Accent background |
| Dark olive green ◼︎ | #4f7b38 | (79, 122, 31) | Selected buttons, Hyperlinks |
| Light green ◼︎ | #b7d886 | (181, 224, 133) | Hover over a button |
| Lighter green ◼︎ | #d3e7b6 | (211, 237, 182) | |
| Verdant Haze ◼︎ | #e6f1d6 | (230, 245, 214) | Unselected buttons |
| Pale Lime Green ◼︎ | #f0f7e7 | (240, 249, 231) | |
| White ◼︎ | #ffffff | (255, 255, 255) |
Naming and Capitalization Guidelines
To ensure consistency in our branding, please follow the guidelines below when referring to Neurodesk and its associated tools.
Correct Usage
- Neurodesk — Capitalize only the first letter.
- neurodesk or NEURODESK may be used if better suited in the context.
- Use “Neurodesk” to refer to the overall project, platform, or community.
- Use consistent casing in product names:
- Neurodesktop
- Neurocommand
- Neurocontainers
- NeurodeskApp
Do Not Use
Avoid the following incorrect variations:
- neuroDesk
- neurodesk in titles or headings
- NeuroDesk
Typography
Font Families
- Logo: Scirich
- Headings: Pontano
- Body Text: Pontano
- Code blocks: Menlo
2 - Running the Neurodesk Site Locally (Hugo + Docsy)
1. Prerequisites
- Git
- Go (required for Hugo modules)
- Hugo extended version (0.121 recommended). See https://github.com/gohugoio/hugo/releases for Hugo releases.
2. Cloning the repository
This step is the same for macOS, Windows, and Linux.
Using SSH
git clone --recurse-submodules git@github.com:NeuroDesk/neurodesk.github.io.git
or
Using HTTPS
git clone --recurse-submodules https://github.com/NeuroDesk/neurodesk.github.io.git
If you cloned without –recurse-submodules
Run the following command to pull submodules
git submodule update --init --recursive --remote
3. Start local hugo server
On Windows:
- Extract the hugo.exe binary from the ZIP file into the root of your neurodesk.github.io directory.
- Open PowerShell or Git Bash, then run:
.\hugo.exe server --disableFastRender
- Once started, your dev website will be accessible via http://localhost:1313
On Mac:
- Extract, move, and authorize the Hugo binary:
cd ~/Downloads #edit according to location of file
tar -xvzf hugo_extended_0.115.4_darwin-universal.tar.gz #unzip the file
chmod +x hugo #Make the hugo file executable
sudo mv hugo /usr/local/bin/hugo-extended #move file to bin folder
- Verify your Hugo installation
hugo-extended version #if it is your first time running this on a Mac, you will see a security warning
You should expect something like this (look for the mention of extended to be sure it worked)
hugo v0.121.0-e321c3502aa8e80a7a7c951359339a985f082757+extended darwin/arm64 BuildDate=2023-12-05T15:22:31Z VendorInfo=gohugoio
Once installed, you can run the server for Mac using:
hugo-extended server --disableFastRender
Once started, your dev website will be accessible via http://localhost:1313
4. Update docsy theme submodule (optional)
git submodule update --remote
git add themes/
git commit -m "Updating theme submodule"
git push origin main