This is the repository of Context Mapper's website https://contextmapper.org/.

To preview the website locally, follow these steps:

1. Install Ruby (3.2 or newer) and the bundler in case you don't have it already:

gem install bundler

2. Install dependencies:

bundle install

3. Run the Context Mapper website (http://localhost:4000):

bundle exec jekyll serve

CML code blocks are highlighted by our own Rouge lexer (_plugins/cml_lexer.rb); use cml as language:

```cml
BoundedContext CustomerManagementContext implements CustomerManagementDomain {
  type = FEATURE
}
```

When the CML grammar gets new keywords, add them to the lexer as well.

For MDSL examples (for example, generated service contracts), use mdsl (_plugins/mdsl_lexer.rb, keywords from the MDSL grammar).

• Production: every push to master is built with Jekyll and deployed to https://contextmapper.org/ (GitHub Pages) by the Build & Deploy Website workflow. Pull requests are built (but not deployed) by the same workflow.
• Previews: to review changes in the browser before merging them, run the Deploy Preview (manual) workflow on your branch (Actions > Deploy Preview (manual) > Run workflow > select the branch). The branch is deployed to Cloudflare Pages and the URL is shown in the workflow run summary (https://<branch>.contextmapper-preview.pages.dev). The previews are protected by Cloudflare Access; ask a maintainer to get access.
• Preview cleanup: the Clean up Previews workflow deletes the preview deployments of deleted branches and keeps only the latest deployment of each existing branch (runs when a branch is deleted, weekly, and manually).

If you think something is missing on our documentation website and you still have unanswered questions, we are happy if you create an issue here allowing us to improve the docs. PRs are always welcome as well!

This website is released under the Apache License, Version 2.0. The fonts in assets/fonts (Inter and JetBrains Mono) are licensed under the SIL Open Font License 1.1.