A central location for managing and improving Project Catalyst.
For more detail see our Contributions policy.
This site is built using Vuepress
- node & npm - Installation Guide covering most platforms
- markdown editor - Suggestions are welcome. I am using VSCode
- git - Easiest client to use is Github Desktop
- Basic knowledge of Markdown Guide
-
Install node
-
Create a github account and install GitHub Desktop
-
Download site code. Go to repository and Download with GitHub Desktop

-
You can start editing all documents inside the src directory right away using your favourite Markdown editor
-
If you want to see effects of your work as you go:
- Go to the project root directory in any terminal and run
npm installto install all the necessary dependencies - Run
npm run devand go to http://localhost:8080/ in your favourite browser to see results of your work immediately
- Go to the project root directory in any terminal and run
-
To build a complete static site run
npm run build, the result is generated in static in the main project directory
There is a simple node.js action configured in .github/workflows/node.js.yml which will build the static site every time new content is pushed to the site.
- Vuepress - Content and structure page
- Vuetify - components and layout page
- js-joda - time travel and other shenanigans page
- vue-marquee-text-component - marquee, due to intergration problems, we are just using the actual component, not the whole the package.
Ubicación principal para administrar y mejorar Project Catalyst.
Para mas detalles vea nuestra Política de contribución.
Este sitio se construyo usando Vuepress
- node & npm - Guia de instalacion en la mayoria de plataformas
- Editor para markdown - Sus sugerencias son bienvenidas. Estoy usando VSCode
- git - Cliente recomendado Github Desktop
- Aprendizaje básico de Markdown Guía
-
Instalar node.
-
Crea una cuenta en Github e instala GitHub Desktop.
-
Descarga el código del sitio. Vaya al repositorio y Descargue mediante GitHub Desktop.

-
Puede comenzar a editar todos los documentos dentro del directorio * src * de inmediato usando su editor de Markdown favorito.
-
Si desea ver el progreso actual de su trabajo:
- Vaya al directorio root del proyecto en cualquier terminal y ejecute
npm installpara instalar todas las dependencias necesarias. - Ejecute
npm run devy vaya a http://localhost:8080/ en su navegador para ver los resultados actuales de su trabajo.
- Vaya al directorio root del proyecto en cualquier terminal y ejecute
-
Para construir un sitio estático completo, ejecute
npm run build, el resultado se genera en static en el directorio principal del proyecto
Hay una acción sencilla de node.js configurada en .github/workflows/node.js.yml la cual actualiza automaticamente el sitio cada vez que se realize un cambio.