Guías
Conozca los conceptos más importantes de docStatic.
Creating pages
Las páginas se diferencian de otros tipos de contenido en que están pensadas como contenido único e independiente, como una página de presentación, un espacio de pruebas o una página de asistencia. Pueden contener componentes React y Markdown. Ten en cuenta que las páginas no tienen barras laterales.
Documentación
2 artículos
Dashboards
docStatic añade la funcionalidad de paneles de control a TinaCMS. Tina genera una API GraphQL utilizando el sistema de archivos del repositorio Git como base de datos. Los paneles de control consultan la API (de forma local o en la nube) y presentan informes con información útil directamente en el CMS. La funcionalidad de los paneles de control se considera actualmente en fase beta. La funcionalidad se ha probado exhaustivamente, pero la interfaz de usuario es provisional y requiere mejoras. Los paneles de control se actualizan cuando se actualiza la página. Si otro usuario ha realizado cambios desde que consultaste un panel de control, puedes hacer clic en Actualizar para actualizarlo.
Blog
La función de blog te permite crear artículos con fecha y hora.
Wikis
Una página wiki es una página web o de documentación diseñada para la colaboración. Se pueden crear y editar en cuestión de minutos y suelen utilizarse tanto para compartir conocimientos dentro del equipo como para ofrecer contenido de ayuda dirigido al público.
Características de Markdown
22 artículos
Styling and layout
Un sitio docStatic es una aplicación React de una sola página. Puedes darle estilo de la misma manera que a las aplicaciones React.
Prose linting with Vale
Vale es un corrector de prosa en línea de comandos que verifica su documentación según reglas de estilo configurables. Se integra bien con archivos Markdown y MDX, lo que lo convierte en una opción natural para los proyectos de docStatic.
Static assets
Los recursos estáticos son los archivos que no son código y que se copian directamente en el resultado de la compilación. Entre ellos se incluyen imágenes, hojas de estilo, favicons, fuentes, etc.
Search
Por defecto, docStatic está configurado para utilizar la búsqueda . Su principal ventaja es que es una solución sin coste alguno. Su principal desventaja es que todo el índice de búsqueda se descarga en el navegador del usuario; cuanto más grande sea tu sitio, más lento será.
Chatbot
docStatic puede añadir a tu sitio web un chatbot con IA que responda a preguntas sobre tu documentación. Por defecto, se ejecuta íntegramente en el navegador del visitante utilizando WebLLM (a través de WebGPU), por lo que no se necesita ningún servicio externo, clave API ni servidor. Este mismo widget también puede redirigirse a un proveedor de pago que alojes tú mismo, sin cambiar nada de lo que ven los visitantes.
Browser support
docStatic te permite definir la lista de navegadores compatibles mediante una configuración de la lista de navegadores. Por lo general, los sitios web deberían funcionar correctamente en cualquier navegador moderno.
Optimización para motores de búsqueda (SEO)
docStatic facilita la optimización para motores de búsqueda (SEO) de diversas formas:
Using plugins
El núcleo del generador de sitios estáticos no ofrece ninguna funcionalidad propia. Todas las funcionalidades se delegan a plugins individuales: la funcionalidad de documentación la proporciona el ; la función de blog, proporcionada por el ; o las páginas individuales proporcionadas por el .
Deployment
De forma predeterminada, docStatic se implementa en . Para otras opciones, consulte en la documentación de Docusaurus.
Internationalization
El generador de sitios web estáticos ofrece compatibilidad con la internacionalización (). Para obtener información detallada, consulta en la documentación de Docusaurus.
CLI
docStatic proporciona un conjunto de scripts que te ayudarán a generar, servir e implementar tu sitio web. Están definidos en la sección scripts del archivo package.json de tu sitio, que es la lista oficial; ejecuta npm run sin argumentos para ver los scripts que tiene realmente tu sitio.