An open API service indexing awesome lists of open source software.

https://github.com/mbeddr/mps-platform-docs

This website collects practical knowledge about MPS and platforms such as MPS-extensions and mbeddr.
https://github.com/mbeddr/mps-platform-docs

best-practices documentation gotchas jetbrains-mps

Last synced: 4 months ago
JSON representation

This website collects practical knowledge about MPS and platforms such as MPS-extensions and mbeddr.

Awesome Lists containing this project

README

          

# MPS Platform Docs

This website collects practical knowledge about MPS and popular MPS platforms such as MPS-extensions and mbeddr. It is written mainly in the form of a Q&A. If you have any feedback, please write a comment at the bottom of a page or
open an issue in this repository.

![build status](https://img.shields.io/github/actions/workflow/status/mbeddr/mps-platform-docs/publish_doc.yml?branch=main)
![license](https://img.shields.io/github/license/mbeddr/mps-platform-docs)
![last commit](https://img.shields.io/github/last-commit/mbeddr/mps-platform-docs)

mps-platform-docs homepage

![Alt](https://repobeats.axiom.co/api/embed/77376fbec2d85c6fc021d2ec238e36dc4b12b45f.svg "Repobeats analytics image")

## Requirements

- Python >= 3.10
- [IntelliJ Excalidraw Integration](https://plugins.jetbrains.com/plugin/17096-excalidraw-integration) (optional)
- [IntelliJ PlantUML Integration](https://plugins.jetbrains.com/plugin/7017-plantuml-integration) (optional)
- [IntelliJ Mermaid](https://plugins.jetbrains.com/plugin/20146-mermaid) (optional)

## Local execution
Run: `./gradlew mkdocsServe` (rebuilds everything on change --> slow)
Better: `./gradlew serveFast`(rebuilds only current page --> fast, only first build is slow)

Build: `./gradlew mkdocsBuild`

## Publishing

`./gradlew mkdocsPublish` is automatically run on push (GitHub Actions). The secret key is just an SSH key from someone who has push permissions for this repository.