Skip to content

Commit

Permalink
📝 update readme and doc
Browse files Browse the repository at this point in the history
Thanks to @johthor
  • Loading branch information
The-Lum committed Nov 13, 2024
1 parent a67665b commit 6ca5831
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 23 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing

Thank you for investing your time in contributing to our project!

## General Recommendation

> :information_source: When adding a new collection document to any of the collections below,
always follow the structure of other documents already present in that collection.
When adding new PUML diagram descriptions don't add any `!theme` or `skin` declarations yourself
as those will be added automatically.

## New Theme

If you want to add a new theme to the gallery,
go to [PlantUML "official" themes](https://github.com/plantuml/plantuml/tree/master/themes) and add it there.
After that, add a new document to the [local themes collection directory](/collections/_themes) describing your theme.
For now, only the themes directly packaged with PlantUML are supported.

## New Skin

For adding a new skin to the gallery,
the steps are nearly the same
but replace `theme` with `skin` e.g. go to [PlantUML skins](https://github.com/plantuml/plantuml/tree/master/skin)
and add a new document to the [local skins collection directory](/collections/_skins).

## New Diagram

If instead you want to add a new diagram type, you will only need to add local files.
First, add a diagram source code PUML file to the [local diagrams input directory](/collections/_diagrams/input).
And second, add a corresponding description document to the [local diagrams collection directory](/collections/_diagrams).

## New Standard Library (stdlib)

Adding another [PlantUML Standard Library](https://github.com/plantuml/plantuml-stdlib) based diagram requires the same steps
as adding a new diagram.
But again replace `diagram` with `stdlib`
and add the new files inside the [local stdlibs collection directory](/collections/_stdlibs).

29 changes: 6 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,13 @@
# Welcome to PlantUML themes Gallery

These are the scripts and Jekyll data collections used to autogenerate the PlantUML Themes Gallery.
## Badges

If you want to add a new theme to the gallery,
go to [PlantUML "official" themes](https://github.com/plantuml/plantuml/tree/master/themes) and add it there.
After that, add a new document to the [local themes collection directory](/collections/_themes) describing your theme.
For now, only the themes directly packaged with PlantUML are supported.
![Count output images](https://img.shields.io/github/directory-file-count/the-lum/puml-themes-gallery/gallery%2Flightmode?label=%23images)

For adding a new skin to the gallery,
the steps are nearly the same
but replace `theme` with `skin` e.g. go to[PlantUML skins](https://github.com/plantuml/plantuml/tree/master/skin)
and add a new document to the [local skins collection directory](/collections/_skins).

If instead you want to add a new diagram type, you will only need to add local files.
First, add a diagram description PUML file to the [local diagrams input directory](/collections/_diagrams/input).
And second, add a corresponding document to the [local diagrams collection directory](/collections/_diagrams).
## Description

Adding another [PlantUML Standard Library](https://github.com/plantuml/plantuml-stdlib) based diagram requires the same steps
as adding a new diagram.
But again replace `diagram` with `stdlib`
and add the new files inside the [local stdlibs collection directory](/collections/_stdlibs).
These are the scripts and [Jekyll](https://jekyllrb.com/) [data collections](https://jekyllrb.com/docs/collections/) used to autogenerate the [PlantUML themes Gallery](https://the-lum.github.io/puml-themes-gallery/).


> :information_source: When adding a new collection document to any of the collections above,
always follow the structure of other documents already present in that collection.
When adding new PUML diagram descriptions don't add any `!theme` or `skin` declarations yourself
as those will be added automatically.

All the sources of the [PlantUML themes Gallery](https://the-lum.github.io/puml-themes-gallery/)
## Contributing
See [Contributing page](CONTRIBUTING.md).
31 changes: 31 additions & 0 deletions input/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Input

## For new diagram

- Put PlantUML `diagram` code on :
- [collections/_diagrams/input/](../collections/_diagrams/input/)
- Put description of the diagram on:
- [collections/_diagrams](../collections/_diagrams)

## For new theme

- Propose a new `theme` as a PR to the main plantuml repo. on:
- [PlantUML "official" themes](https://github.com/plantuml/plantuml/tree/master/themes)
- Put description of the theme on:
- [collections/_themes](../collections/_themes)

## For new standard library (stdlib)

- Propose a new `stdlib` as a PR to the main plantuml stdlib repo. on:
- [PlantUML Standard Library](https://github.com/plantuml/plantuml-stdlib/tree/master/stdlib)
- Put `stdlib diagram` code example on :
- [collections/_stdlibs/input](../collections/_stdlibs/input/)
- Put description of the sdlib on:
- [collections/_stdlibs](../collections/_stdlibs)

## For new skin

- Propose a new `skin` as a PR to the main plantuml repo. on:
- [PlantUML "official" skins](https://github.com/plantuml/plantuml/tree/master/skin)
- Put description of the skin on:
- [collections/_skins](../collections/_skins)

0 comments on commit 6ca5831

Please sign in to comment.