Jekyll Documentation Generator: Trace the Source to the Route

Your guide index lists Overview and Verify, yet the individual pages are absent. A collection can be listed while its document output is disabled.

Keep the collection’s output setting beside the route expectations, then check the files produced by a fresh Jekyll build.

The source builder produces original configuration, two Markdown guides, layouts and an index loop as copyable text. Output mode changes both configuration and expected routes; content-only mode suppresses individual links. A missing-front-matter scenario flags Verify separately, while the page prepares source rather than compiling it.

Jekyll Documentation Generator: Trace the Source to the Route
Jekyll Documentation Generator: Trace the Source to the Route
Open the full example ↗

Specify the authored collection documents

Source Title Numeric order Exact original body
_guides/overview.md Overview 1 Read the supplied workflow first.
_guides/verify.md Verify 2 Compare output routes with source IDs.

Retain front matter with title and numeric order in each document. The collection label guides maps to _guides under the chosen source structure. Use the source packet below as copyable starting text for those files in your native Jekyll project.

Jekyll's collections documentation explains collection folder naming, front-matter processing and explicit individual output. Without front matter, a file is treated as a static file rather than processed document content. Flag that difference before the later build instead of diagnosing every missing guide page as the same output-setting defect.

Make individual output an explicit configuration choice

The source packet declares guides as a collection mapping with output: true and permalink /guides/:name/. A front-matter default scoped to collection type guides selects the original guide layout; the root index has its own intended layout.

The official collection tutorial distinguishes iterating collection contents from creating each document's page, and describes scoped defaults and restarting after configuration changes. Check your Jekyll version and restart after changing _config.yml so the next build uses the new collection setting.

The supplied guide layout places the page title above its content. Its default layout wraps that content in the document, so both guide pages can use the same structure.

Sort the navigation by the supplied order

The original root index iterates site.guides sorted by numeric order. It should display Overview first and Verify second, regardless of the source filenames' incidental ordering.

For an output-enabled guide, take its generated doc.url rather than constructing a link to the Markdown filename. Jekyll's filter documentation describes relative_url, which accounts for the configured baseurl. Avoid adding the same prefix a second time.

Compare the document route with the final navigation href. With an empty baseurl, the expected links are /guides/overview/ and /guides/verify/. With /docs as the baseurl, the expected href begins /docs/guides/. The guide source still lives in _guides; the baseurl does not rename that directory.

Test output false as a different mode

Choose Content only to generate output: false, then reload that configuration when you build with Jekyll. The index may still list the supplied collection titles/content, but individual guide output is absent in its new destination.

Suppress individual-route links in that stage and label the listing as content-only. Do not leave anchors to routes that the current build does not produce or declare a successful link merely because an old destination still has the page.

This configuration experiment is not a draft/published-content toggle. The authored guide records can still participate in the collection while individual output changes.

Inspect the source packet

Choose Output true and enter an optional local baseurl such as /docs. Build source packet displays configuration and the expected navigation hrefs /docs/guides/overview/ and /docs/guides/verify/. Their expected destination paths remain guides/overview/index.html and guides/verify/index.html inside the build destination.

Choose Content only and rebuild the packet. With both front matters present, the expected listing contains Overview and Verify without individual links. Remove Verify front matter and rebuild: only Overview remains in the processed listing. Verify is shown separately as unprocessed source needing review. Edits clear old expectations.

Build the copied files with Jekyll to check the expected routes. Use a fresh destination so an older guide page cannot hide a configuration change. Compare the files Jekyll produces with the two expected paths, then check the navigation under your chosen baseurl.

Copy this prompt

Create a browser-based source builder for a small Jekyll documentation collection. The page prepares copyable file contents and expected routes; it does not execute Jekyll. Place collection settings above a source packet and a separate route explanation.

Use two documents. _guides/overview.md has title Overview, numeric order 1 and body "Read the supplied workflow first." _guides/verify.md has title Verify, order 2 and body "Compare output routes with source IDs." Both normally have YAML front matter.

Generate _config.yml declaring guides as a collection mapping, an explicit output setting, permalink /guides/:name/, and a front-matter default selecting layout guide for collection type guides. Include original default and guide layouts. The index reads the collection, sorts site.guides by order, and uses doc.url with relative_url when individual output is enabled. In content-only mode, show titles without individual links.

Provide Output true and Content only buttons, a local baseurl input and Build source packet. Accept an empty baseurl or a local path such as /docs. Reject schemes, queries and fragments. With output enabled, the expected routes are /guides/overview/ and /guides/verify/, and the destination paths are guides/overview/index.html and guides/verify/index.html. Prefix navigation hrefs with the baseurl once.

Add Toggle Verify front matter. When it is absent, omit Verify from the processed content-only listing, identify its unprocessed source separately and do not assert a processed Verify route. Settings edits clear previous packet and route results. Reset restores individual output, empty baseurl and both front matters.

Return a self-contained HTML file with readable copyable source blocks and responsive controls. Label all routes as expectations to compare with a later Jekyll build.

Build both output modes

Generate the packet with /docs, copy the files into your Jekyll project and compare the built navigation with the expected hrefs. Then rebuild into a fresh destination with content-only mode. NOS can render the HTML source builder for reviewing those configuration choices. Use the two builds to confirm why a listed title and an individual guide page are different results.

Keep reading