Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate some complex docs content #14

Merged
merged 14 commits into from
Apr 5, 2024
Merged

Migrate some complex docs content #14

merged 14 commits into from
Apr 5, 2024

Conversation

davidjgoss
Copy link
Contributor

@davidjgoss davidjgoss commented Mar 29, 2024

🤔 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 #11 (comment)

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:

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

🏷️ What kind of change is this?

  • 📖 Documentation (improvements without changing code)
  • ⚡ 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.

Copy link

netlify bot commented Mar 29, 2024

Deploy Preview for cucumber-site-new ready!

Name Link
🔨 Latest commit 9419fa8
🔍 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...

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 davidjgoss changed the title poc for language tabs poc for polyglot content support Mar 29, 2024
@davidjgoss
Copy link
Contributor Author

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

@davidjgoss davidjgoss changed the title poc for polyglot content support poc for complex content support Apr 5, 2024
@davidjgoss davidjgoss changed the title poc for complex content support Migrate some complex docs content Apr 5, 2024
@davidjgoss davidjgoss marked this pull request as ready for review April 5, 2024 14:08
@davidjgoss
Copy link
Contributor Author

🤦 fixed!

@mpkorstanje
Copy link

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.

@davidjgoss davidjgoss merged commit b613539 into main Apr 5, 2024
4 checks passed
@davidjgoss davidjgoss deleted the feat/language-tabs branch April 5, 2024 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants