Add URL encoding in style guide

d2l-ai · Aug 4, 2022 · 398a429 · 398a429
1 parent d5fc1c3
commit 398a429
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md
@@ -128,6 +128,14 @@
 * Refer to [d2lbook](https://book.d2l.ai/user/markdown.html#cross-references) on how to add references for figure, table and equations.
 
 
+## URL
+
+When setting `style = cambridge`, URLs will be converted into QR code, which requires replacing special characters with [URL encoding](https://www.urlencoder.io/learn/). For example:
+
+`Stanford's [large movie review dataset](https://ai.stanford.edu/~amaas/data/sentiment/)`
+->
+`Stanford's [large movie review dataset](https://ai.stanford.edu/%7Eamaas/data/sentiment/)`
+
 
 ## Citations