search

lukashornych / evitalab

Official web-based GUI client for evitaDB e-commerce database. It is built to help developers who use evitaDB with exploring and debugging their domain structure and data. Besides standard query executing, it also supports multiple no-code tools to quickly navigate through domain structure, docs and data without needing to write any queries.
https://github.com/lukashornych/evitalab
Apache License 2.0
7 stars 1 forks source link

CSS styling from evitaDB docs in evitaLab markdown renderer #50

Closed lukashornych closed 8 months ago

lukashornych commented 8 months ago

In evitaLab we use markdown renderer (https://github.com/markdown-it/markdown-it) for rendering schema descriptions and entity property values. Currently, the renderer renders only base HTML without any CSS styling, therefore it's not pretty and not much usable when the markdown source in more complicated. Also, we would like the rendered markdown to match styling from evitaDB docs.

After some discussion with @MiroslavAlt, the simplest way to implement this right now, will be to copy needed CSS classes from evitaDB docs into evitaLab. In future, we may consider publishing some CSS lib with the common classes, but for now this copying should be enough. More so because we need only subset of what evitaDB supports, as in evitaLab there is only plain markdown without custom React components.

Note: before we can realize this, we need to finish the entity property value detail, because there is implementation of the new markdown renderer.

cc @MiroslavAlt

lukashornych commented 8 months ago

Support for basic MD elements solved in #48. If support for more specific elements will be needed in future, we will open new specific issue.