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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

markdown format #2427

Merged
merged 1 commit into from Mar 1, 2024
Merged

markdown format #2427

merged 1 commit into from Mar 1, 2024

Conversation

OniriCorpe
Copy link
Member

Problem

  • many pages are really improperly formatted 馃槄馃槄馃槄馃槄

Solution

  • i ran my markdown formater over all the pages and manually corrected a lot of things I could see
  • it'll deserve a second in-depth manual pass to correct the in-line HTML

PR checklist

  • I'm not doing a PR for an application, I promise, I know that this kind of changes must go directly into the app packages themselves
  • PR finished and ready to be reviewed

@OniriCorpe OniriCorpe merged commit 0ecfb7f into master Mar 1, 2024
@OniriCorpe OniriCorpe deleted the markdown-format branch March 1, 2024 22:14
Copy link
Member

@alexAubin alexAubin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

馃槵

- If you're using the domain provider Namecheap the SRV DNS entries are formatted as **Service**: _xmpp-client **Protocol**: _tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: your.domain.tld
- If you're using the domain provider Namecheap the SRV DNS entries are formatted as **Service**: _xmpp-client **Protocol**:_tcp **Priority**: 0 **Weight**: 5 **Port**: 5222 **Target**: your.domain.tld
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, that one looks like a legit space, otherwise _foobar_ with be interpreted as bold/italic ? But it looks like we should have some backticks in there because that's pretty much code

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[[figure caption="Serveur distant"]![](image://vps.png?height=75)[/figure]](/install/hardware:vps_debian)
[[figure caption="Serveur distant"]![][image://vps.png?height=75](/figure)](/install/hardware:vps_debian)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uuuuh, wut, are we sure about this ? this looks like some sort of [figure]stuff[/figure] syntax ? with stuff being ![](someimage)

Copy link
Member Author

@OniriCorpe OniriCorpe Mar 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm yeah it returns this error
https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md011.md

we can tell it to shut up with:
<!-- markdownlint-disable-file MD011 -->

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