This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Documentation

How to edit the documentation

1 - Designer Guide

Guidelines for visual consistency, colors, typography, logos, and imagery across Neurodesk platforms.

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.


Inclusivity & Pride logo


Horizontal format logo


Logos for Dark Backgrounds

These logos are optimized for use on dark backgrounds:


Inclusivity & Pride logo


Other Variants

No image


Color Palette

You can download the official Neurodesk color palette file for design use:

Primary Colors

Color NameHex CodeRGB CodeUsage
Seafoam green ◼︎#6aa329(106, 163, 41)Primary actions

Secondary Colors

Color NameHex CodeRGB CodeUsage
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: Neurorich
  • Headings: Pontano
  • Body Text: Pontano
  • Code blocks: Menlo

2 - Local Hugo Docsy

How to edit the documentation

Local Hugo Docsy in Linux and WSL2

https://github.com/NeuroDesk/neurodesk.github.io/blob/main/CONTRIBUTING.md

Local Hugo Docsy in Windows

Clone repository

Using SSH

git clone --recurse-submodules git@github.com:NeuroDesk/neurodesk.github.io.git

or 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

Download Hugo binary

Hugo releases are on https://github.com/gohugoio/hugo/releases

Download latest version of hugo extended

e.g. for windows: https://github.com/gohugoio/hugo/releases/download/v0.88.1/hugo_extended_0.88.1_Windows-64bit.zip

Start local hugo server

Extract hugo binary (hugo.exe) to your neurodesk.github.io dir

Run server for windows: .\hugo.exe server --disableFastRender

Once started, dev website will be accessible via http://localhost:1313

Update docsy theme submodule

git submodule update --remote
git add themes/
git commit -m "Updating theme submodule"
git push origin main