Documentation for Jolie v1.10.x.

Before making a pull request, test your changes by building the documentation locally. Use the Docker image provided in this branch to build a mdBook accessible on localhost:3000. Edit the files in the directory src and wait for mdBook to reload the page to see your edits (be patient, it may take up to a minute).

Requirement

• nodejs
• rust

cargo install mdbook mdbook-mermaid

npm install --prefix highlight-jolie && npm run --prefix highlight-jolie build-and-copy

This repo has integrated with MegaLinter and pre-commit, which will help maintaining the consistency of the repository. The project is configured to be run against documentation flavors.

See more on the tools: MegaLinter and pre-commit

npx mega-linter-runner --flavor=documentation --remove-container

You can add the new word by append the string to words field in .cspell.json. Otherwise, you can also add a cSpell's specific comment to ignore the word directly to the file e.g. <!-- cSpell:ignore brics -->.

run it with

docker compose up

and stop it with

docker compose down

Build the image with

docker build -t jolie-docs .

Then run it with

docker run --rm -it \
    -p 3000:3000 \
    -v "$(pwd)"/src:/jolie-docs:ro \
    jolie-docs