You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Prettier is a very popular pretty printer tool. It could be used to format javascript, yaml, markdown, and a lot more file formats.
Unfortunately, it has compatibility issues with syntax proposed by this extension.
If I run prettier --write . command it will change my document like this:
diff --git a/docs/reference.md b/docs/reference.md
index 3143ee2..fa4022d 100644
@@ -1,13 +1,10 @@
# Reference
::: generics.private
- :docstring:+:docstring:
::: generics.delegated
- :docstring:+:docstring:
::: generics.defended
- :docstring:+:docstring:
<p align="center">— ⭐ —</p>
<p align="center"><i>The generics library is part of the SOLID python family.</i></p>
I I run prettier --prose-wrap=always --write . commant it will change my document like this:
diff --git a/docs/reference.md b/docs/reference.md
index 3143ee2..fa4022d 100644
@@ -1,13 +1,10 @@
# Reference
-::: generics.private- :docstring:+::: generics.private :docstring:-::: generics.delegated- :docstring:+::: generics.delegated :docstring:-::: generics.defended- :docstring:+::: generics.defended :docstring:
<p align="center">— ⭐ —</p>
<p align="center"><i>The generics library is part of the SOLID python family.</i></p>
None of these variants is compatible with the auto doc extension provided by this package.
Similar extensions like admonitions works fine with prettier. For example, you can use in this way:
!!! note
Subtyping inheritance with `abc.Meta` is not implemented yet. We have plans to implement it in the future.
The result will look like this. Scroll up a little bit to see a note
Is there any way to make it work with prettier? If no, could you explain how could I could extend the project to achieve it? Happy to make a small pull request to make this happen.
Have a good day 🌴
Best regards,
Artem.
The text was updated successfully, but these errors were encountered:
Hello, thanks for wonderful tool!
Prettier is a very popular pretty printer tool. It could be used to format javascript, yaml, markdown, and a lot more file formats.
Unfortunately, it has compatibility issues with syntax proposed by this extension.
If I run
prettier --write .
command it will change my document like this:I I run
prettier --prose-wrap=always --write .
commant it will change my document like this:None of these variants is compatible with the auto doc extension provided by this package.
Similar extensions like admonitions works fine with prettier. For example, you can use in this way:
The result will look like this. Scroll up a little bit to see a note
Is there any way to make it work with prettier? If no, could you explain how could I could extend the project to achieve it? Happy to make a small pull request to make this happen.
Have a good day 🌴
Best regards,
Artem.
The text was updated successfully, but these errors were encountered: