Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rendering custom properties in markdown properties table #272

Open
mrsameman opened this issue Oct 21, 2024 · 1 comment
Open

Rendering custom properties in markdown properties table #272

mrsameman opened this issue Oct 21, 2024 · 1 comment

Comments

@mrsameman
Copy link

Hi!
Do you plan to support custom properties in properties_table ? namely extending logic here

I understand that it's not an easy thing and will require some sort of callback to handle all possible content rendering.
But maybe you are open to have a limited support in a way of adding description-like fields?
Because in our project we use custom fields to store info related to our database and would like to add it to the docs.
So with following schema

{
  "$id": "registry/schema.json",
  "type": "string",
  "description": "schema descripiton",
  "title": "Schema title",
  "database_type": "String",
  "database_default": ""
}

We would like to see something like this:

**Title:** Schema title

|          |          |
| -------- | -------- |
| **Type** | `string` |

**Description:** schema descripiton
**Database Type:**: String
**Database Default:**: ""
----------------------------------------------------------------------------------------------------------------------------
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) on 2024-10-18 at 17:11:56 +0200
@dblanchette
Copy link
Collaborator

dblanchette commented Nov 29, 2024

What would you think of adding a configuration option with the list of custom properties you want to display?

Otherwise, it'd be difficult to differentiate the properties you want to display and those you do not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants