Skip to content

Commit 00808e7

Browse files
intro: warning not to embed file from same repository in code block
related: practicalli/journal#6
1 parent 461d365 commit 00808e7

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- intro: add code of respect
1515
- dev: stale issue & pr scheduled check (monthly)
1616
- intro: lexers for markdown code block syntax highlights in writing tips
17+
- intro: warning not to embed file from same repository in code block
1718

1819
## Changed
1920
- mkdocs: correct github url for repo and edit link

docs/writing-tips.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,9 @@ Specifying a local file from the root of the book project (the directory contain
312312

313313
An effective way of sharing code and configuration mutliple times in a book or across multiple books.
314314

315+
!!! WARNING "Avoid embedding file from same repository"
316+
An `HTTP Error 429: Too Many Requests` can occur when running `mkdocs serve` due to embedding a file in a code block that comes from the same repository as the site being built.
317+
315318
## Content tabs
316319

317320
Create in page tabs that can also be

0 commit comments

Comments
 (0)