Contributor Guide

This guide explains how to add and modify content on NucMed Atlas. The site is built with Hugo using the Hextra theme.

Quick Start

File Structure

content/
├── docs/
│   ├── notes/           # Study notes by topic
│   │   ├── physics/     # Physics chapters
│   │   ├── cardiovascular/
│   │   └── ...
│   ├── cases/           # Clinical cases
│   └── mcq/             # Practice questions
├── videos/              # Video lectures
└── about/               # About page

Creating Content

All content files are Markdown (.md) files with YAML front matter.

Adding Notes

Section Index Page

Create _index.md in the topic folder:

---
title: Topic Name
weight: 1               # Order in navigation
sidebar:
  open: false           # Collapsed by default
---

Brief description of the section.

## Chapters

Use cards shortcode to link to chapters

Chapter Page

Create individual chapter files with this structure:

---
title: Chapter Title
weight: 1
---

Then add content with:

• Learning Objectives - Bulleted list of goals
• Main Content - Organized with headings
• Callouts - To highlight key points
• Tables - For comparisons
• Practice Problems - Using details shortcode

Adding MCQs

Use the MCQ shortcode with these parameters:

Format: Options should be listed as A., B., C., D. on separate lines.

Example structure:

MCQ shortcode with:
- id="unique-id"
- question="Your question?"
- correct="B"
- explanation="Why B is correct"

A. First option
B. Correct answer (this one)
C. Third option
D. Fourth option

Adding Cases

Structure a case file with these sections:

1. Front Matter - Title only
2. Clinical History - Patient details, symptoms
3. Imaging Findings - Description with embedded images
4. Diagnosis - Final diagnosis and discussion
5. Learning Points - Key takeaways as bullet list

Useful Shortcodes

Callouts

Three types available:

• type="info" - Blue, for general information
• type="tip" - Green, for helpful tips
• type="warning" - Yellow/orange, for cautions

Details (Expandable)

Creates collapsible sections. Use title parameter for the header text.

Cards

Creates linked card grids. Use inside a cards container with:

• link - URL or relative path
• title - Card title
• subtitle - Card description

Tabs

Creates tabbed content. Use items parameter with comma-separated tab names.

Front Matter Options

Running Locally

cd nucmedatlas
hugo server

Open http://localhost:1313 to preview changes.

Best Practices

1. Use descriptive titles - Clear, concise chapter names
2. Include learning objectives - Help readers know what to expect
3. Add tables - Compare/contrast information effectively
4. Use callouts - Highlight key points and clinical pearls
5. Keep paragraphs short - Easier to read on screens
6. Add practice problems - Reinforce learning
7. Link related content - Cross-reference other sections