Detalhes do pacote

@scalar/code-highlight

scalar294.8kMIT0.2.0

Central methods and themes for code highlighting in Scalar projects

syntax, highlight, lowlight, highlightjs

readme (leia-me)

Scalar

<picture> <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/9b639f2d-0204-4b15-b918-158072a9afa5"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/be723d07-ec9c-4edb-b657-05a8bc05c7d6"> </picture> <picture> <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/b391b82f-d993-4e97-8a17-1c3c7ccbb19b"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/579d0853-b2a5-4ea8-b2bd-a98753faeaf3"> </picture>

Interactive API Reference from OpenAPI/Swagger

└ Renders OpenAPI/Swagger documents
└ Comes with an API testing tool
└ Doesn't look like 2011
└ Generates code examples for many languages & frameworks
└ Integrates with your favorite framework
└ Try Demo

An offline-first API Client built for OpenAPI

└ Free and open-source
└ First-class OpenAPI/Swagger support
└ Integrates with dozens of API Frameworks (Elysia, Hono, FastAPI, etc)
└ Syncs with your favorite server framework (Watch Mode)
└ Has environment variables, dynamic parameters and everything
└ Try It in the Browser └ Download (Windows, MacOS, Linux)

### Trusted by:

<picture> <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/73dcef95-fc4f-4111-bb09-f3ce37453a81#gh-light-mode-only"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/c792c977-8551-432c-9417-3ea05e408151#gh-dark-mode-only"> Scalar API client </picture> <picture> <source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/1da6b904-34be-4760-b535-0dd2160e6d12#gh-light-mode-only"> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/54a9ea69-c50a-4f49-8c3e-ddd6f8fbe1f3#gh-dark-mode-only"> Scalar API client </picture>

Quickstart

All you need is a single HTML file to create an amazing API reference:

<!doctype html>
<html>
  <head>
    <title>Scalar API Reference</title>
    <meta charset="utf-8" />
    <meta
      name="viewport"
      content="width=device-width, initial-scale=1" />
  </head>

  <body>
    <div id="app"></div>

    <!-- Load the Script -->
    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>

    <!-- Initialize the Scalar API Reference -->
    <script>
      Scalar.createApiReference('#app', {
        // The URL of the OpenAPI/Swagger document
        url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
        // Avoid CORS issues
        proxyUrl: 'https://proxy.scalar.com',
      })
    </script>
  </body>
</html>

Need a Custom Header? Check out this example: https://codepen.io/scalarorg/pen/VwOXqam

And there's an ever-growing list of plugins and integrations:

Integrations

Built-in Support

The following frameworks have chosen Scalar API Reference as their default OpenAPI documentation UI, recognizing its developer-friendly features and modern design:

Managed Hosting

We're offering a free and paid managed hosting on the edge, too:

Write your API documentation and publish API references (free)
YOUR_NAME_HERE.apidocumentation.com subdomain and SSL (free)
GitHub Sync
Write free-form documentation
Collaborate with your team
Use any domain

Ready? Create your Scalar Account

Documentation

Topic	Description
Configuration	The universal configuration object
Themes	Predefined themes, layouts & styling
OpenAPI	OpenAPI specification extensions
Markdown	Supported Markdown syntax
Plugins	Extend the functionality

Projects

Project	Description
Scalar API Reference	Self-hosted API Reference
Scalar API Client	Postman alternative
Scalar Registry	Manage OpenAPI documents
Scalar Docs	Hosted documentation
Scalar Docs Starter	Starter template for Scalar Docs
Scalar SDKs	SDK generation
Scalar CLI	Command-line interface
Scalar Mock Server	Mock APIs from OpenAPI documents
Scalar Galaxy	Our OpenAPI Example
Scalar Editor	OpenAPI Online Editor
Scalar OpenAPI Parser	Parse OpenAPI documents
Scalar OpenAPI Upgrader	Upgrade OpenAPI documents
Scalar Void Server	HTTP Request Mirror

Community

We are API nerds. You too? Let's chat on Discord: https://discord.gg/scalar

Contributions

Contributions are welcome! Read the CONTRIBUTING guide.

Top 10 Contributors (April 2025)

Top Contributors (All Time)

_hanspagel	_amritk	_xC0dex	_antlio	_marclave	_hwkr
_{cameronrohani}	_geoffgscott	_DemonHa	_tmastrom	_marcalexiei	_inyourtime
_bgrcs	_gevann	_federicobond	_ahmedrangel	_matthyk	_Amorim33
_baywet	_liamdscalar	_ivanagas	_Mason-Little	_RemcoGoy	_adjsky
_mcollina	_mpminardi	_TheVaan	_si-net	_nsychev	_Mohib834
_lc-soft	_fuma-nama	_Edgaraszs	_ATREAY	_yshrsmz	_hex0id
_soulchild	_horpto	_x-delfino	_ykdojo	_timheuer	_ledgersteve
_{SebastianBienert}	_mouhannad-sh	_{mason-at-pieces}	_luc122c	_handrews	_gsmcdonald
_WDaan	_Duncanma	_roryschadler	_rmp135	_mirismaili	_STP5940
_captainsafia	_realsama	_ventocis	_dotfortun	_smoores-dev	_soGit
_sinh117801	_stratosblue	_yokeTH	_Huliiiiii	_rpmccarter	_{hrynevychroman}
_rbange	_{rickihastings}	_rhuanbarreto	_{petercinibulk}	_Olexandr88	_Lazialize
_{malinbranduse}	_mvt147	_MaxBreida	_tinchoz49	_{not-my-profile}	_MarioGK
_{DmitriiKhudiakov}	_unnoq	_tsiwek-piwik	_dunklesToast	_stefanprobst	_{omerp-explorium}
_o-az	_milksense	_kwaichanz	_jpjpjp	_g-airey	_ga1az
_{FotieMConstant}	_danwithabox	_{WilliamBonvini}	_bsdayo	_Chinlinlee	_bingbeann
_{zakaria-shahen}	_{rolldeep-stepmerrily}	_{Wolf-Syndrome}	_{wilcoschoneveld}	_rotciw	_WesleySkeen
_Ma-ve	_Mai0313	_{Courtcircuits}	_rektdeckard	_{thibaultleouay}	_diegolopes
_untiny	_lundibundi	_DavidNiessen	_darekaze	_danp	_danjohnson95
_yungwarlock	_ClanEver	_chrislearn	_chadwhitacre	_carstenlebek	_cactysman
_brunogrcsada	_{brianheineman}	_Borisich	_bdpiprava	_BenJeau	_saithis
_zsilbi	_{arthurfiorette}	_arashsheyda	_sigpwned	_gizero	_alewin
_slash686	_ahmadi-akbar	_{MathurAditya724}	_abdulamite	_{luke-hagar-sp}	_ShadiestGoat
_mrlubos	_sanscontext	_kyllian	_jlnslv	_IHIutch	_jonataw
_Jannchie	_jwangnz	_Jefwillems	_Tholdrim	_JacobCoffee	_kevinand11
_tltsutltsu	_eltociear	_IceyWu	_iagobalmeida	_hpmouton	_CJHwong
_HelgeSverre	_Hamidrzash	_255kb	_GreyXor	_Fdawgs	_filiabel
_facus26	_{emmanuel-ferdman}	_{elliott-with-the-longest-name-on-github}	_elliotnash