Advanced guides
En esta sección se describen las funciones más avanzadas de docStatic, incluidas las integraciones:
Front Matter CMS
Al crear contenido en un IDE como , las funciones que ofrece el CMS no están disponibles. En un flujo de trabajo típico, los desarrolladores crean o editan contenido modificando directamente el archivo MDX en el IDE, y los redactores limpian y etiquetan el contenido en el CMS. Si el desarrollador olvida incluir la fecha de la última modificación, hay que consultar las propiedades del archivo para obtener esa información. Sin embargo, existe un CMS ligero disponible como complemento llamado Front Matter. El repositorio docStatic incluye un ejemplo de configuración de Front Matter. Para obtener más información, consulte la documentación de Front Matter.
CMS alojado
1 artículo
Notifications
docStatic utiliza para enviar notificaciones de flujos de trabajo. En la carpeta .github/workflows/ se incluyen ejemplos de notificaciones de revisión y traducción. Para activarlas, es necesario realizar cierta configuración en GitHub. También puedes utilizarlas como punto de partida para desarrollar tus propias notificaciones personalizadas.
MCP Server Integration
1 artículo
OpenAPI reference docs
docStatic utiliza docusaurus-plugin-openapi-docs para generar documentación de referencia de API a partir de una especificación OpenAPI. El plugin lee un archivo de especificación y escribe un conjunto de archivos MDX en su árbol docs/ que Docusaurus construye como páginas normales.
Style checking
Una de las funciones que más echan en falta los redactores que trabajan con «docs-as-code» es un buen corrector ortográfico, gramatical y de estilo. Por defecto, la revisión ortográfica la proporciona el navegador web o el entorno de desarrollo integrado. Esto puede ser suficiente para sitios web sencillos, pero si necesitas algo más avanzado, necesitarás un corrector gramatical específico.
Los desarrolladores interesados en ampliar la funcionalidad de docStatic deben consultar las Guías y las Guías avanzadas de la documentación de Docusaurus.