https://github.com/halbgut/contentful-plantuml-generator
Quickly get an overview of a Contentful space
https://github.com/halbgut/contentful-plantuml-generator
contentful plantuml
Last synced: 2 months ago
JSON representation
Quickly get an overview of a Contentful space
- Host: GitHub
- URL: https://github.com/halbgut/contentful-plantuml-generator
- Owner: halbgut
- Created: 2018-03-11T17:02:12.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-27T07:59:50.000Z (about 7 years ago)
- Last Synced: 2024-10-16T09:23:52.367Z (6 months ago)
- Topics: contentful, plantuml
- Language: JavaScript
- Homepage:
- Size: 6.84 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contentful PlantUML generator
Quickly get an overview of a Contentful space.
## Usage
```
contentful-plantuml-generator ${SPACE_ID} ${CONTENT_MANAGEMENT_TOKEN} \
| plantuml -pipe -tsvg \
> my-diagram.svg
```
## Info
This tool generates a class diagram based on a Contentful space. It fetches the Contentful "Content Model" of a specified space and then converts this to PlantUML syntax. You can then generate a diagram using the PlantUML CLI.
It's pretty MVP. So there might be cases where the script fails.
## Requirements
* [Node.js (> 8.9)](https://nodejs.org/)
* [PlantUML](http://plantuml.com)
## Installation
```
npm i -g contentful-plantuml-generator
```