Skip to content

Markdown instructions

Darren Clarke edited this page Nov 29, 2021 · 8 revisions

Guide to editing chapter pages

This site uses most of the available markdown language commands to specify different elements of a chapter page. They are listed in the order they appear on a typical page.

READING TIME

The reading time section at the top of the page is specified by the h6 (######) tag. You do not need to include the words "READING TIME", just a value like "15-20min".

Example:

###### 30-60min

INFORMATIONAL TAGS

The informational tags provide details about the chapter's level, requirements, etc. which appear above the title and are enclosed by a black outline. They are specified with ul (-) syntax.

Example:

- Intermediate Level
- Security Assessment Exercise
- Pen/Paper, Post-its, Computer Text File

CHAPTER TAGS

The chapter tags provide the phase and chapter numbers and appear in a filled bubble in the chapter's highlight color. They are specified with the ol (1.) syntax.

Example:

1. Phase 1: Research
2. Chapter 2

CHAPTER TITLE

The chapter title is the largest text on the page. It appears in the chapter-specific color and is specified with the h1 tag (#).

Example:

# Working with a community

CHAPTER SECTIONS

Chapter sections are the second largest text on the page and are rendered in black. They are specified with the the h2 (##) syntax.

Example:

## Working with communities and setting up secure communications

BODY TEXT

Body text is rendered in black and doesn't require any markdown. Two returns equals a new paragraph.

Example:

How you conduct research, design, and build with and for communities is one of the most foundational parts of human rights centered design. In an HRCD process, you should already be working with a community. This chapter is going to focus on safe and secure ways for you to collaborate with that community (and the next chapter focuses on the different kinds of research you and your collaborators can do together!). 

HRCD isn’t just about the structure for doing work, it’s how you are doing that work, and how that work can accidentally or inadvertently harm collaborators, users, and community members you work with.

CHAPTER STEPS

The chapter steps are rendered in with a background of the chapter-specific color in the same font size as the chapter sections. They are specified by the h3 (###) syntax.

Example:

### Step 1: Know your community

IMAGES

Images are specified with the standard markdown syntax.

Example:

![alt text](/images/uxs-icon-1.svg)

EXERCISE HEADERS

Exercise headers have a solid background of the chapter-specific color. They are specified by the h4 (####) syntax.

Example:

#### Exercise 1: Assess how secure your communications are

EXERCISE BODY

The exercise body is specified by the code (```) syntax. It has a background of the chapter-specific color and can include paragraph breaks.

Example:

```
Before you start building the tool, platform, or technology, you want to know the people who will be using them. Consider collecting and analyzing information background to render a clear hierarchy visible from your stakeholders and research participants.

This is another paragraph.
```