Eclipse Sprotty Project Website

This repository contains the source for the website of Eclipse Sprotty:

https://sprotty.org

The main repository is found at eclipse-sprotty/sprotty.

Repository Structure

• hugo – Hugo content including static web pages and documentation in Markdown format
• tailwind – Tailwind CSS configuration
• showcase – Live examples of Sprotty diagrams

How to generate reference documentation

The reference documentation is generated using TypeDoc and requires manual steps in order to be integrated into the website structure.

1. Install typedoc and typedoc-plugin-markdown globally

   npm i -g typedoc typedoc-plugin-markdown

2. Navigate to the package you want to create the reference for (ex: sprotty-protocol)

3. Generate documentation

   npx typedoc src/index --skipErrorChecking --plugin typedoc-plugin-markdown --flattenOutputFiles

4. This should have generated a new docs folder with many markdown files in the root of the package

5. Copy the content of this folder into the correct place in sprotty-website (hugo/content/docs/ref/[library]).

6. In sprotty-website run the process-docs script. This is needed to adapt the generated links to what hugo is expecting

   npm run process-docs