search

bakdata / kpops

Deploy Kafka pipelines to Kubernetes
https://bakdata.github.io/kpops
MIT License
12 stars 1 forks source link

Fix docs setup page list indentation #377

Closed sujuka99 closed 10 months ago

sujuka99 commented 10 months ago

closes #375

sujuka99 commented 10 months ago

It's dprint that's auto-creating the problem, how should I approach that?

disrupted commented 10 months ago

It's dprint that's auto-creating the problem, how should I approach that?

does the dprint ignore pragma solve this?

sujuka99 commented 10 months ago

It's dprint that's auto-creating the problem, how should I approach that?

does the dprint ignore pragma solve this?

Yes, but I checked now and the same problem appears in almost all ordered lists in the docs.. It's kinda inconvenient to add enclosing comments to each list

disrupted commented 10 months ago

Yes, but I checked now and the same problem appears in almost all ordered lists in the docs.. It's kinda inconvenient to add enclosing comments to each list

If it's easy to reproduce we can open an issue for it in https://github.com/dprint/dprint-plugin-markdown

sujuka99 commented 10 months ago

Yes, but I checked now and the same problem appears in almost all ordered lists in the docs.. It's kinda inconvenient to add enclosing comments to each list

If it's easy to reproduce we can open an issue for it in https://github.com/dprint/dprint-plugin-markdown

When I render it as normal Markdown the issue isn't there. dprint isn't wrong, it's mkdocs that renders it "wrongly"

sujuka99 commented 10 months ago

Update: for some reason lists are indented with 3 spaces.. I'm gonna go through the docs to fix that

sujuka99 commented 10 months ago

MKdocs is using python-markdown and it is known to have some problems. Find sources below:

https://github.com/mkdocs/mkdocs/issues/2153#issuecomment-667427322 https://github.com/Python-Markdown/markdown/issues/53

sujuka99 commented 10 months ago

Well, turns out we don't have that many lists, so I did ignore them all.

dprint doesn't have a setting for the list indent unfortunately and it's fixed at 3. We need 4, so the ignores are needed.