APIDoc 4.0 introduce un sistema dinámico de temas de highlight.js que permite personalizar el resaltado de sintaxis con más de 160 temas disponibles.
highlightTheme
en apidoc.json
Agrega el campo highlightTheme
a tu apidoc.json
:
{
"name": "Mi Documentación API",
"version": "1.0.0",
"description": "Documentación con resaltado personalizado",
"highlightTheme": "tokyo-night-dark",
"title": "Mi API"
}
{"highlightTheme": "tokyo-night-dark"} // Tema oscuro moderno (predeterminado)
{"highlightTheme": "github-dark"} // Tema oscuro de GitHub
{"highlightTheme": "monokai"} // Clásico Monokai
{"highlightTheme": "dracula"} // Popular tema Dracula
{"highlightTheme": "androidstudio"} // Tema Android Studio
{"highlightTheme": "vs2015"} // Visual Studio 2015
{"highlightTheme": "tomorrow-night"} // Tomorrow Night
{"highlightTheme": "gruvbox-dark"} // Gruvbox oscuro
{"highlightTheme": "github"} // Tema claro de GitHub
{"highlightTheme": "vs"} // Visual Studio claro
{"highlightTheme": "atom-one-light"} // Atom One Light
{"highlightTheme": "xcode"} // Tema Xcode
{"highlightTheme": "tomorrow"} // Tomorrow claro
{"highlightTheme": "foundation"} // Foundation
{"highlightTheme": "lightfair"} // Light Fair
{"highlightTheme": "rainbow"} // Arcoíris colorido
{"highlightTheme": "magula"} // Magula vibrante
{"highlightTheme": "sunburst"} // Sunburst brillante
{"highlightTheme": "hybrid"} // Hybrid colorido
// Cambiar tema dinámicamente (función disponible globalmente)
window.loadHighlightTheme('dracula');
window.loadHighlightTheme('github-dark');
window.loadHighlightTheme('monokai');
github
, github-dark
, github-dark-dimmed
monokai
, dracula
, tomorrow-night
, solarized-dark
, solarized-light
tokyo-night-dark
, tokyo-night-light
, nord
, gruvbox-dark
, gruvbox-light
vs
, vs2015
, androidstudio
, xcode
, idea
, intellij-light
default
, lightfair
, far
, foundation
, ascetic
brown-paper
, school-book
, old-school
, pojoaque
rainbow
, magula
, sunburst
, hybrid
, kimbie-dark
, kimbie-light
arta
, codepen-embed
, color-brewer
, dark
, darkula
, docco
far
, felipec
, foundation
, github-gist
, gml
, googlecode
gradient-dark
, grayscale
, hopscotch
, ir-black
, isbl-editor-dark
isbl-editor-light
, kimbie-dark
, kimbie-light
, lightfair
, lioshi
magula
, mono-blue
, monokai-sublime
, night-owl
, nnfx-dark
nnfx-light
, nord
, obsidian
, ocean
, paraiso-dark
, paraiso-light
purebasic
, qtcreator-dark
, qtcreator-light
, railscasts
, rainbow
routeros
, shades-of-purple
, srcery
, stackoverflow-dark
stackoverflow-light
, sunburst
, tokyo-night-dark
, tokyo-night-light
tomorrow
, tomorrow-night-blue
, tomorrow-night-bright
tomorrow-night-eighties
, a11y-dark
, a11y-light
, agate
, an-old-hope
atom-one-dark
, atom-one-dark-reasonable
, atom-one-light
, base16
brown-paper
, codepen-embed
, color-brewer
, darkula
, default
tokyo-night-dark
incluido en el CSS principal (391KB)assets/highlight-themes/
# Los temas se procesan automáticamente durante la construcción
npm run build
# Para desarrollo local
npm run build:example
Si estabas usando un tema personalizado de highlight.js en v3.x:
"highlightTheme": "nombre-del-tema"
a apidoc.json
El nuevo sistema es más eficiente y maneja automáticamente los conflictos de temas.
assets/highlight-themes/
github
, vs
, atom-one-light
github-dark
, vs2015
, tokyo-night-dark
github
, default
, foundation
github-dark
, monokai
, dracula
xcode
, atom-one-light
, foundation
tomorrow-night
, nord
, gruvbox-dark
rainbow
, sunburst
, magula
, hybrid
github-dark
default
(~2KB)tokyo-night-dark
(~8KB)El sistema de temas de APIDoc 4.0 te permite crear documentación visualmente atractiva con el resaltado de código perfecto para tu marca y audiencia. ¡Experimenta con diferentes temas para encontrar el que mejor se adapte a tu proyecto!