cortexjs.io
1.0.0
Este repositorio contiene los archivos de origen para el sitio web "Cortexjs.io".
git submodule init
git submodule update
# Setup, make a dev build and start a server
npm start # Pick-up changes in the dependent modules
npm run update
# Generate .md files for API and launch local server
npm startnpm run stage
# Make a clean production build.
# Output goes inside submodules/cortex-js.github.io
npm run restart
# Validate that everything works well in the browser then...
npm run deploy
# submodules/cortex-js.github.io (a git submodule) gets pushed to cortex-js.github.ioEl sitio se publica utilizando páginas GitHub. El principal beneficio de usar páginas de GH es la integración del flujo de trabajo (Pubshing to GH desencadena una actualización automática del sitio que se está sirviendo)
El contenido de los sitios se crea principalmente como archivos de Markdown, procesados con eleventy para convertirlos en HTML/CSS.
La configuración eleventy principal se encuentra en el archivo config/eleventy.js , incluida la definición de la reducción de usar.
El motor Markdown es markdown-it que implementa Commonmark.
El complemento mardown-it-attrs permite el estilo de los párrafos, por ejemplo
Este es un aviso. {.notice-Info}
El complemento markdown-it-deflist admite listas de definición de estilo PANDC:
Term 1
: Definition 1
: Second definition
La salida se encuentra en el directorio submodules/cortex-js.github.io . Ese directorio es un submódulo GIT que está vinculado a cortex-js.github.io Repo. Ese repositorio es el publicado por GH Pages (para la organización, solo se puede publicar un repositorio completo, para proyectos, el contenido puede estar contenido en el directorio A /docs ).
Ver también submódulos.
El repositorio cortex-js.github.io también debe incluir dos archivos adicionales:
.nojekyll que indica a GitHub que no debe procesar el contenido de este repositorio con Jekyll (ya que este ya es el resultado de Jekyll)CNAME con un contenido de cortexjs.io Estos archivos se crean al ejecutar npm run stage .
Use la pestaña Configuración en el repositorio cortex-js.github.io para indicar el uso de un dominio personalizado.
Además, las entradas DNS para cortexjs.io deben incluir lo siguiente:
www.cortex-js.io a cortex-js.io El comando npm run build genera la documentación para las API desde el archivo .d.ts mecanografiado en la build/ directorio.
El proceso de compilación utiliza la herramienta typedoc para analizar los archivos de encabezado API y emitir un archivo json en la build/ directorio.
Nota: Para depurar el convertidor, use el depurador VSCode. Seleccione Depurar> Comience a depurar para iniciar una sesión de depuración directamente en VScode.
El script build-guides luego convierte el archivo json en Markdown en el directorio ./src/build , que luego se puede procesar por altuentería con npm run build o npm start .
La información de estilo CSS se define en src/_sass/ .
La documentación de la API debe seguir la Guía de estilo de documentación de Google (https://developers.google.com/style/api- reference-comments) y https://developers.google.com/style
Además, el código TypeScript debe seguir la Guía de estilo de Google: https://google.github.io/styleguide/jsguide.html#naming
El proyecto sigue el estándar GitHub para nombrar scripts del proyecto.
Para hacer una construcción local:
npm startPara hacer una construcción lista para ser escenificada:
npm run stageLa "prueba" del sitio generado consiste en verificar los enlaces, y que el HTML generado es válido.
