Skip to content
Eclipse eCAL™

Edit the documentation

This documentation is createt with Astro and uses the Theme Starlight.

In this tutorial we will teach you how to edit the documentation locally on your PC. For that we will use Visual Studio Code and Node.js which you will need for building the site and also for dev Preview.

  1. Checkout the eCAL git repository:

    Terminal window
        git clone https://github.com/eclipse-ecal/ecal.git

  2. Download and install Visual Studio Code on your PC (it is available for Windows, Linux and macOS). https://code.visualstudio.com/

  3. Download and install Node.js. https://nodejs.org/en

  4. Navigate to the eCAL directory where the docs folder is located. Access the docs folder and install the requirements with npm.

    Terminal window
        npm install

  5. Now you can run:

    Terminal window
        npm run dev

    for dev Preview in your Browser (http://localhost:4321)

  6. Run:

    Terminal window
        npm run build

    for Building the application, the Build files will be located at /dist/..