0
319
ViewsJSDoc: ¿Cómo incluye una plantilla de archivo css personalizada en sus documentos generados?
Los documentos JSDoc dicen
Copiar un directorio de imágenes al directorio de salida. Para copiar todos los archivos estáticos en ./myproject/static al directorio de salida:
"default": { "staticFiles": { "include": [ "./myproject/static" ] } }Si su directorio de archivos estáticos contiene el archivo ./myproject/static/img/screen.png, puede mostrar la imagen en sus documentos usando la etiqueta HTML
<img src="img/screen.png">.
Y entonces tengo esto en mi jsdoc.config.json
"templates": { "default": { "staticFiles": { "include": [ "doc/_static/css/index.css" ] } } }Mi archivo css se agrega a la carpeta con mis documentos generados,
pero realmente me gustaría que todos mis documentos generados incluyan ese archivo css, y no tener que colocar manualmente una etiqueta <style src="index.css" /> en mis documentos generados automáticamente
No está en el encabezado de mis documentos generados automáticamente, como puede ver en la imagen a continuación.
me gustaria que la cabeza fuera algo asi
<head> <meta charset="utf-8"> <title>JSDoc: Home</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="index.css"> </head>1 answers
Answer question0
Creo que es posible que deba proporcionar un archivo de diseño personalizado (HTML) utilizando la propiedad de configuración templates.default.layoutFile .
"templates": { "default": { "layoutFile": "custom-layout.tmpl" } }La ruta al archivo es relativa a:
Las rutas relativas se resuelven con el directorio de trabajo actual; la ruta al archivo de configuración; y el directorio JSDoc, en ese orden.
Este es un archivo de plantilla de ejemplo para usar con templates.default.layoutfile
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1" /> <title><?js= title ?></title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <link type="text/css" rel="stylesheet" href="dark.css"> <link type="text/css" rel="stylesheet" href="index.css"> </head> <body> <nav class="sidebar"> <header class="nav-header"> <a href="index.html"> <img class="nav-logo" src="images/logo.svg" src="image" onerror="this.onerror=null; this.src='images/logo.png'" alt="alt text" /> <h1>Project Name</h1> </a> </header> <?js= this.nav ?> </nav> <div id="main"> <h1 class="page-title"><?js= title ?></h1> <?js= content ?> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc <?js= env.version.number ?></a> </footer> </body> </html>