Esta información se encuentra también disponible en Español
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 install
to install all the necessary dependencies - Run
npm run dev
and 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.