cypress-documentation icon indicating copy to clipboard operation
cypress-documentation copied to clipboard

Heading ids

Open robertguss opened this issue 2 years ago • 3 comments

  • used https://docusaurus.io/docs/cli#docusaurus-write-heading-ids-sitedir to manually create heading ID's to keep the same case

robertguss avatar Aug 04 '22 16:08 robertguss

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
cypress-documentation ✅ Ready (Inspect) Visit Preview Aug 4, 2022 at 4:07PM (UTC)

vercel[bot] avatar Aug 04 '22 16:08 vercel[bot]

@jaffrepaul I manage to find in their docs that they have a CLI to manually create custom heading IDs. I ran it to preserve the case which should match what our current docs site does. The only problem is that some of the headings do not match exactly like prod, but the majority of them should work now with this. The ones that don't work, we can manually update and fix, but this should get us more than 90% there I think.

robertguss avatar Aug 04 '22 16:08 robertguss

@elylucas I have spoken with Paul about this PR already, but wanted your eyes on it as well. Docusaurus has a CLI that allows us to give headings specific ID's and so I ran the CLI to create custom ID's for every header but maintain the case, like our docs site does currently. This should hopefully solve 90% of the links. Happy to talk more about this when you get back.

robertguss avatar Aug 05 '22 17:08 robertguss