🚨 You are viewing the legacy v1.x docs. See the new v2 documentation →

Pages Overview

If you need to add more long-form documentation to live alongside your component previews you can do so using Lookbook’s markdown-powered pages system.

For an example of some pages in Lookbook, check out the example pages in the Lookbook demo app and the associated page files in the demo repo.

Adding pages

Pages should be placed in the test/components/docs directory (although this can be customised) and can be nested in directories as deeply as required.

  β”œβ”€β”€ overview.md.erb
  β”œβ”€β”€ best_practices.md.erb
  └── branding/
      β”œβ”€β”€ logos.md.erb
      └── themes.md.erb

Pages must have either a .html.erb or a .md.erb file extension. All pages are rendered as ERB templates but .md.erb files will also additionally be run through a markdown parser.

Pages can optionally make use of a YAML frontmatter block to customise the behaviour and content of the page itself.

An example page file might look like this:

title: An example page
label: Nice example

This is an example page. If it has a `.md.erb` file extension its
contents will be run through a Markdown parser/renderer before display.

Fenced code blocks are fully supported and will be highlighted appropriately.

ERB can be used in here.
The template will be rendered **before** being parsed as Markdown.

You can can access data about the page using the `@page` variable.
The title of this page is "<%= @page.title %>".

Because pages are rendered as ERB templates, it’s possible to do things like dynamically link to other pages, embed previews directly in the page, and more.

Ordering pages and directories

If you want to enforce a specific order for pages and directories in the Lookbook navigation you can prefix the file/directory basename with an β€˜order number’ integer value followed by an underscore or hyphen.

For example: 01_example_page.md.erb will be displayed first in the navigation (01) within the directory it is in.

The integer value will be parsed out from the filename so that it doesn’t appear in navigation labels or URLs, and the value itself will be used as a β€˜position’ number when sorting the navigation items.

For example, an ordered directory of pages might look like:

  β”œβ”€β”€ 01_overview.md.erb
  β”œβ”€β”€ 02_implementation_notes/
  β”‚   β”œβ”€β”€ 01_slots.md.erb
  β”‚   └── 02_html_attributes.md.erb
  └── 03_helpful_examples/
      β”œβ”€β”€ 01_basic_components.md.erb
      └── 02_complex_components.md.erb

Without the number prefixes on the file names the pages may not have appeared in the navigation in the desired order.