Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Nov 4, 2025

Add supported syntax highlighting languages to code blocks documentation

Summary

Added a "Supported languages" section to the code blocks component documentation listing the 10 languages that Fern supports for syntax highlighting (curl, python, javascript, typescript, go, ruby, csharp, php, swift, rust) along with their aliases. The section was placed after "Usage" and before "Variants" for easy discoverability when users are learning about code block language identifiers.

Review & Testing Checklist for Human

  • Verify language list accuracy - The list was sourced from the SupportedLanguage enum in fern-platform/fern/apis/fdr/definition/api/v1/read/endpoint.yml (lines 230-244). Please confirm this is complete, current, and matches what actually works in production.
  • Test all languages and aliases - Verify that all listed languages (curl, python, javascript/js/node, typescript/ts, go, ruby, csharp, php, swift, rust) actually render with syntax highlighting in the preview deployment. Pay special attention to the aliases.
  • Check preview rendering - Verify the section renders correctly and is positioned appropriately for users looking for this information. The direct link is in the preview comment.

Notes

  • Placement was corrected from OpenAPI extensions page (initial error) to the code blocks component page per user feedback
  • Includes note about graceful degradation for unsupported languages (displays without highlighting)
  • Used sentence case for heading and contractions to satisfy Vale style checks

Link to Devin run: https://app.devin.ai/sessions/9eac3151b1ae48beba6a26f7a790c163
Requested by: Chris McDonnell (chris@buildwithfern.com) (@cdonel707)

…ples

Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

- `swift`
- `rust`

If you specify a language that is not in this list, Fern will still display the code sample but without syntax highlighting.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'that's' instead of 'that is'.

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

@github-actions
Copy link
Contributor

github-actions bot commented Nov 4, 2025

@devalog devalog merged commit ee23152 into main Nov 4, 2025
2 checks passed
@devalog devalog deleted the devin/1762283713-syntax-highlighting-languages branch November 4, 2025 20:58
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.

2 participants