Migrate some complex docs content

davidjgoss commented 5 months ago

🤔 What's changed?

Documentation link in header now links to docs section in this site, not the old site
Some documentation pages ported over from the Gherkin and Cucumber sections, including some React stuff to make the more complex needs work
All languages we show code in are syntax highlighted

(Bear in mind this site is still not live; we are working towards parity with the current site at cucumber.io so we can smoothly swap at some future point.)

⚡️ What's your motivation?

See https://github.com/cucumber/website/issues/11#issuecomment-2027322217

We wanted to try porting some docs content over to this repo to make sure we can adequately handle the more complex kinds of content. Specifically:

[x] Gherkin localisation tables
[x] Tabs for code samples in different languages
[x] Sync of language choice to URL
[x] Persistance of language choice across pages
[x] Equivalent of "short codes" for language-specific wording (e.g. "method" vs "function" et al)
[x] Syntax highlighting for all languages we show code in

🏷️ What kind of change is this?

:book: Documentation (improvements without changing code)
:zap: New feature (non-breaking change which adds new behaviour)

This text was originally generated from a template, then edited by hand. You can modify the template here.

netlify[bot] commented 5 months ago

Deploy Preview for cucumber-site-new ready!

Name	Link
Latest commit	9419fa8eaeaf0ef66491eb918b31ca574ea586c0
Latest deploy log	https://app.netlify.com/sites/cucumber-site-new/deploys/66101310d9518100083596d5
Deploy Preview	https://deploy-preview-14--cucumber-site-new.netlify.app
Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

davidjgoss commented 5 months ago

This now includes a shortcode-style thing working with a MDX component like:

A Step Definition is a <Term>stepdef-body</Term> with an

With some more work we should hopefully be able to make this a CommonMark directive like:

A Step Definition is a :term[stepdef-body] with an

mpkorstanje commented 5 months ago

On https://deploy-preview-14--cucumber-site-new.netlify.app/docs/cucumber/step-definitions

davidjgoss commented 5 months ago

🤦 fixed!

mpkorstanje commented 5 months ago

Looks good. As a 1-to-1 replacement this will work.

It looks like it will not solve the problem where whole sections do not apply to a certain language, but we can solve that differently.

vegetable-specification-society / website