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

doc: Fix typos, escape [ and format table in README.md #291

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

langbein-daniel
Copy link

👋 I did some awesome work for the Pelias project and would love for everyone to have a look at it and provide feedback.


Here's the reason for this change 🚀

While reading through the main README of this project, I improved some formatting and fixed some typos. The content remains the same.

I escaped the first of the two [[ as some markdown readers think that e.g. [[design doc](docs/design-doc.md)] is a label. If viewed on GitHub, there is no difference, the links remain working.


Here's how others can test the changes 👀

View the README.md file.

@missinglink
Copy link
Member

Thanks for the PR, couple questions:

  1. Why is the square bracket escaping required? it seems to render fine on Github:

Screenshot 2023-02-28 at 22 57 34

  1. Same for the table, it seems to be rendering fine as-is?

Screenshot 2023-02-28 at 23 00 07

As seen at: https://github.com/pelias/interpolation

I also tried rendering the markdown in glow on the command line and it seems to render fine there too:

Screenshot 2023-02-28 at 23 01 12

Screenshot 2023-02-28 at 23 01 48

Are you having problems with a specific markdown renderer?
I'd like to know if it's a problem with the markdown encoding or the renderer, I've never had a problem with this syntax in the past.

@langbein-daniel
Copy link
Author

I'm using the Markdown editor of a JetBrains IDE (IntelliJ).

1)

Lets look at this snippet [[design doc](docs/design-doc.md)] [[relationship to pelias](docs/introduction.md)].

My IDE checks Markdown links before each commit. While searching for links that are not inline (such as [link-text][label] and in another line [label]: http://some.url), it detected [[relationship to pelias](docs/introduction.md)] as label because just before it there is some text in square brackets [[design doc](docs/design-doc.md)].

image

I've double checked with CommonMark and my IDE is actually wrong in that it detects [...] [...] as non inline link. There must not be a space between the link text in [] and the label in []. See https://commonmark.org/help/tutorial/07-links.html (click on the plus for details).

So I can very gladly remove the \ again. Whereby the \, except for the readability of the source text, should have no harm.

2)

The tables are definitely fine as is. Only the readability (of the source code) is not perfect.

Markdown aims to be well readable, even in source code. Therefore I have often seen tables formatted with spaces, where the | are aligned exactly on top of each other. And so already in the editor a visually correct table results.

image

My IDE can "format" a Markdown table with spaces automatically, so it's not necessary to do this manually.

I just thought the formatted table might be handy for people reading the README in plain text. But I don't have a strong opinion about this. We can happily leave it as it was before as well.


I definitely would not have opened a commit just for (1) and (2) alone. I hope now not to have generated too much effort with it ;) And I'll try to open an Issue at my IDEs Markdown plugin so that it does not detect []<SPACE>[] as label anymore.

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

Successfully merging this pull request may close these issues.

3 participants