chore(markdown): Avoid lengthy inline code
Code that is inline (and not a code block) will not be forced to a new line. So very long lines of code inline will break the layout. Put them in a code block instead. I already restructured the link part a bit.
This commit is contained in:
parent
ed30a24a54
commit
8ab7bf5840
1 changed files with 21 additions and 5 deletions
|
@ -40,12 +40,28 @@ See first list item for an example.
|
|||
|
||||
## Make sure your links lead where they think you do
|
||||
|
||||
- When you are linking within freesewing you can use a relative link from
|
||||
### Lining within the same website
|
||||
|
||||
- When you are linking within freesewing.dev or freesewing.org you can use a relative link from
|
||||
the site root.
|
||||
Think `markdown/dev/guides/markdown/frequent-mistakes` instead of
|
||||
`https://github.com/freesewing/freesewing/tree/develop/markdown/dev/guides/markdown/frequent-mistakes`
|
||||
- Images can be put in the same folder you are working on with a link
|
||||
to the filename.
|
||||
Use:
|
||||
```
|
||||
/guides/markdown/frequent-mistakes
|
||||
```
|
||||
instead of
|
||||
|
||||
```
|
||||
https://freesewing.dev/guides/markdown/frequent-mistakes
|
||||
```
|
||||
|
||||
### Linking images
|
||||
|
||||
Images can be put in the same folder you are working on with a link
|
||||
to the filename. For example:
|
||||
|
||||
```md
|
||||
This is [a picture of a banana](banana.jpg)
|
||||
```
|
||||
|
||||
## Avoid ambiguity when lising a number of steps
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue