Skip to content

Commit a2292cd

Browse files
committed
docs: updated
1 parent fa9d642 commit a2292cd

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,15 +119,21 @@ This is only for Medium
119119

120120
## Relative Images
121121

122-
To use images contained in the same folder of the blog articles use `@` as source path. `@` will be parsed
123-
as the URL to the repository/<articles_folder>.
124-
E.g.
122+
To use images contained in the same folder of the blog articles use `@/<image_path>`.
123+
`@` refers to `https://raw.githubusercontent.com/<owner>/<repo>/<articles_folder>`
124+
125+
Example:
125126
```
126127
![image](@/img1.png)
127-
128128
<img src="@/img2.jpg" />
129129
```
130130

131+
Will be parsed as
132+
```
133+
![image](https://raw.githubusercontent.com/<owner>/<repo>/<articles_folder>/img1.png)
134+
<img src="https://raw.githubusercontent.com/<owner>/<repo>/<articles_folder>/img2.jpg" />
135+
```
136+
131137
## Developing
132138

133139
Run tests
@@ -158,4 +164,4 @@ Please submit a PR with any contribution. Refer to the list of `TODO's` or open
158164
- [ ] Support publishing to only 1 platform
159165
- [ ] Support edition and auto update of articles
160166
- [ ] Support multiple articles
161-
- [ ] Upload relative images
167+
- [x] Relative images to github raw server

0 commit comments

Comments
 (0)