docs: migrate docs(related to standard writer) into writer

yeqown · Nov 16, 2021 · d2f7026 · d2f7026
1 parent 504a1a7
commit d2f7026
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/docs/qrcode_structure.png b/docs/qrcode_structure.png
diff --git a/writer/standard/README.md b/writer/standard/README.md
@@ -68,4 +68,9 @@ func WithCustomImageEncoder(encoder ImageEncoder) ImageOption
 // WithBorderWidth(a, b) mean top/bottom equal to `a`, left/right equal to `b`.
 // WithBorderWidth(a, b, c, d) mean top, right, bottom, left.
 func WithBorderWidth(widths ...int) ImageOption
-```
+```
+
+### extension
+
+- [How to customize QR Code shape](./how-to-use-custom-shape.md)
+- [How to customize ImageEncoder](./how-to-use-image-encoder.md)
diff --git a/docs/how-to-use-custom-shape.md → writer/standard/how-to-use-custom-shape.md b/docs/how-to-use-custom-shape.md → writer/standard/how-to-use-custom-shape.md
@@ -1,12 +1,12 @@
 ## How to use custom shape
 
-[Source Code](../example/with-custom-shape/main.go)
+[Source Code](../../example/with-custom-shape/main.go)
 
 first step, you must define your own shape to QRCode, which consists of two part:
 * normal cell (of course, there are many types, separator, timing, alignment patter, data, format and version etc)
 * finder cell (to help recognizer to locate the matrix's position)
 
-<img src="./qrcode_structure.png" align="center" width="50%" />
+<img src="../../assets/qrcode_structure.png" align="center" width="50%" />
 
 ```go
 type IShape interface {

diff --git a/writer/standard/how-to-use-image-encoder.md b/writer/standard/how-to-use-image-encoder.md
@@ -0,0 +1 @@
+## Customize image encoder