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

Missing space in lists when generating MKDocs #262

Open
pareion opened this issue Sep 18, 2024 · 0 comments
Open

Missing space in lists when generating MKDocs #262

pareion opened this issue Sep 18, 2024 · 0 comments

Comments

@pareion
Copy link

pareion commented Sep 18, 2024

Hello!

We just started using this library and find it excellent. There is however a few minor issues when generating the MKDoc files.

Example:
billede

We're using the following schema definition:

{
  "$schema": "https://json-schema.org/draft/2019-09/schema",
  "title": "Deployment",
  "type": "object",
  "description": "Environment config.",
    "properties": {
      "environment": {
        "type": "string",
        "description": "Which environment to use.",
        "default": "dev",
        "enum": [
          "test",
          "dev",
          "stage",
          "prod"
        ]
      }
  },
  "additionalProperties": false
}

The following json-schema-for-humans configuration

template_name: md
show_toc: False
with_footer: False
examples_as_yaml: True
template_md_options:
  badge_as_image: True
  show_heading_numbers: False
  properties_table_columns:
  - Property
  - Type
  - Title/Description

I suggest adding a new line in the json_schema_for_humans/templates/md/section_one_of.md file, but I'm not sure if it breaks anything.

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

1 participant