Writing Features
CB-Essay provides specialized includes that extend Markdown for scholarly writing. This essay demonstrates every feature with working examples you can copy directly into your own work.
The copy-and-replace principle: Find a feature you like, copy the code block, paste it into your essay, and replace the content with yours. That’s it!
Basic Markdown
Start with standard Markdown formatting:
Headings
## Heading 2
### Heading 3
#### Heading 4
Text Formatting
Bold text with **bold**
Italic text with *italic*
Bold italic with ***bold italic***
Links
Link text with [text](url)
Images
Lists
Bulleted:
- Item one
- Item two
- Nested item
Numbered:
- First item
- Second item
- Third item
Code Blocks
Use triple backticks for code:
```yaml
---
title: Your Essay
order: 1
---
```
Blockquotes
Styled quotations with optional attribution and source links.
Basic Blockquote
Knowledge comes, but wisdom lingers
Copy this:
{% include essay/feature/blockquote.html
quote="Knowledge comes, but wisdom lingers"
speaker="Alfred Lord Tennyson" %}
With Source Citation
It is a truth universally acknowledged, that a single man in possession of a good fortune, must be in want of a wife.
Copy this:
{% include essay/feature/blockquote.html
quote="Your quote text here"
speaker="Author Name"
source="Book or Article Title" %}
Large Centered Quote w/ No Border
The best way out is always through
Copy this:
{% include essay/feature/blockquote.html
quote="Your dramatic quote"
speaker="Famous Person"
size="xl"
align="center"
border=false %}
Size options: sm, md, lg, xl, xxl
Align options: left, center, right
Asides (Margin Notes)
Margin notes appear beside your text on desktop, inline on mobile.
Text-Only Aside
Here’s a paragraph with a margin note.This is a margin note providing additional context or commentary. The text continues naturally, and the aside appears in the margin.
Copy this:
{% include essay/feature/aside.html
text="Your margin note text here" %}
Aside with Collection Item
Collection items can appear in asides with thumbnails.
Click to view
Administration Building, University of Idaho, No. 30 The aside shows a preview of the item with a link to view it.
Copy this:
{% include essay/feature/aside.html
objectid="demo_001"
text="Context about this item" %}
Note: The objectid must exist in your collection metadata CSV file.
Image Galleries
Display multiple collection items as inline galleries.
Copy this:
{% include essay/feature/image-gallery.html
objectid="item1;item2;item3" %}
Separate multiple object IDs with semicolons. Items must exist in your metadata.
Filtered Collection Galleries
Below is another type of gallery, one that is filtered from the collection based on liquid logic (here it is item.format contains 'image' and item.date > '1920') with an optional header.
Items Dated after 1920
Copy this:
{% include feature/gallery.html
heading="Items Dated after 1920"
captions=false
filter="item.date > '1920'" %}
Mini Maps
Embed small maps at specific coordinates.
Copy this:
{% include feature/mini-map.html
latitude="46.727485"
longitude="-117.014185"
map-zoom="18"
caption="This is the library where I work!" %}
Finding coordinates:
- Right-click location on Google Maps → Click coordinates to copy
- Or use LatLong.net
Zoom levels: 1 (world) to 18 (street level)
Section Transitions
Create visual breaks between major sections using scrollama transitions.
New Major Section
The section break above creates a visual pause and scroll-triggered transition effect. This helps structure long essays into distinct parts.
Copy this:
{% include essay/new-section.html %}
## Your New Section Title
Content continues here...
Use sparingly - 3-4 sections per essay maximum for best effect.
CollectionBuilder Features
Beyond essay-specific includes, you can use any standard CollectionBuilder feature:
Item Cards
Copy this:
{% include feature/card.html
objectid="demo_001"
width="50"
centered=true %}
Shows a card with the item image and metadata.
Item Images
Copy this:
{% include feature/image.html
objectid="demo_012"
width="75" %}
Displays an item image with caption from metadata.
Timelines
For essays with chronological elements, embed the full timeline:
{% include feature/timeline.html %}
Subject Clouds
Visualize subject keywords from your collection:
{% include feature/cloud.html fields="subject" %}
Combining Features
You can combine multiple features for rich, scholarly presentations:
Example: Blockquote + Aside + Map
I went to the woods because I wished to live deliberately
Thoreau’s cabin was located on the shores of Walden PondThe cabin measured 10 feet by 15 feet and cost $28.12 to build. in Concord, Massachusetts, where he lived from 1845 to 1847.
The location provided the solitude Thoreau sought for his philosophical experiment in simple living.
Print & PDF Output
Most features work in print PDFs. Blockquotes, asides, images, and section breaks all render beautifully. Mini-maps and videos are web-only and won’t appear in print.
Visit the Print Hub to generate PDFs in Letter, A4, or 6×9″ formats. See the Print Guide for complete details including margin note styles, page formats, and accessibility features.
Best Practices
Blockquotes
- Use for significant quotations only
- Always attribute with
speakerparameter - Keep quotes focused and relevant
- Don’t nest blockquotes
Asides
- Maximum 3-4 per essay
- Keep text brief (1-3 sentences)
- Ensure objectids exist in metadata
- Test display on mobile AND in print preview
Maps
- Verify coordinates are accurate
- Choose appropriate zoom level (12-14 for cities)
- Add context about the location in text
- Note: Maps won’t appear in print PDFs (web-only feature)
Section Breaks
- Use for major structural divisions
- 3-4 maximum per essay
- Ensure sections are substantial
- Works best with longer essays (1000+ words)
Next Steps
You now know every feature available in CB-Essay! The final essay shows how to integrate collection items more deeply:
Remember: Copy any feature from this page, replace the content with yours, and it will work in your essay!