doc: Fix typos, escape [ and format table in README.md#291
doc: Fix typos, escape [ and format table in README.md#291langbein-daniel wants to merge 1 commit intopelias:masterfrom
Conversation
|
Thanks for the PR, couple questions:
As seen at: https://github.com/pelias/interpolation I also tried rendering the markdown in Are you having problems with a specific markdown renderer? |
|
I'm using the Markdown editor of a JetBrains IDE (IntelliJ). 1)Lets look at this snippet My IDE checks Markdown links before each commit. While searching for links that are not inline (such as I've double checked with CommonMark and my IDE is actually wrong in that it detects So I can very gladly remove the 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 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 |






👋 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.