alphagov / tech-docs-gem

Gem to distribute the tech docs project
https://tdt-documentation.london.cloudapps.digital/
MIT License
15 stars 38 forks source link

Can't add partial markdown file without an h1 #277

Closed timja closed 3 years ago

timja commented 3 years ago

image

Originally posted by @timja in https://github.com/alphagov/tech-docs-gem/issues/251#issuecomment-950783270

Repo: https://github.com/hmcts/hmcts.github.io

Branch: add-partial

Page: http://localhost:4567/ways-of-working/troubleshooting/#troubleshooting-issues

Compare view: https://github.com/hmcts/hmcts.github.io/compare/add-partial

skip to source/ways-of-working/troubleshooting/clusters.md

(I'm on x-gov slack as well)

richardTowers commented 3 years ago

It looks like the tech-docs-tool is trying to treat your partial as a full page.

Could you try prefixing the filename with an _ (so _culsters.md) to see if that fixes it?

The Middleman docs on partials suggest that this is needed: https://middlemanapp.com/basics/partials/

timja commented 3 years ago

Oh thanks! sorry for the noise

richardTowers commented 3 years ago

No worries, happy we could help!