Redocly / Redocly/redoc

Add support for Elixir language

Open
#2,756 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the problem to be solved
Redoc is a pretty common solution for API documentations when using Elixir. But Redoc itself doesn't support that language syntax highlighting.

Describe the solution you'd like
Prism already supports the language, so I believe that it only need to be imported to start working.

If the reason for not having all prism languages is because it would make the code bloated, then maybe there is a good way for the end user to add support for any language when needed?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Prism language registration or import path in the TypeScript code and compare how existing languages are enabled. Confirm the change by rendering API documentation containing Elixir syntax and checking that highlighting works. Treat the broader question of on-demand language loading as separate unless the scope is clarified.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir, typescript
Domain
documentation
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.