Crear un documento
En DocStatic, escribes tu contenido como Markdown en archivos llamados «Temas». Normalmente, crearás cada tema tú mismo, aunque ciertos tipos de documentos pueden tener temas generados automáticamente.
Nota
Los documentos GraphQL y OpenAPI se generan automáticamente desde un servidor o esquema.
Para crear un tema:
- En la colección Temas, haz clic en Añadir archivo.
- Dale un Título al tema.
- (Opcional) Si desea utilizar el tema en la ayuda contextual, asígnele un Slug. Se trata de una ruta fija desde
/docs/. - Asigne una Descripción al tema. Esta se muestra en la Lista de tarjetas de documentos.
- (Opcional) Añada las Etiquetas de taxonomía necesarias.
- (Opcional) Establezca las Condiciones.
- Asegúrese de que el estado del flujo de trabajo está establecido en Borrador.
- Introduzca su contenido.
- Haga clic en Guardar.
Parte inicial del documento
Al comienzo de cada tema hay una sección de YAML contenida entre dos conjuntos de tres guiones (---). DocStatic utiliza esto para cosas como:
- Texto condicional
- Taxonomías (etiquetas de documento)
- Flujos de trabajo
Para obtener más información, consulta Crear un documento en la documentación de Docusaurus.