Doc automation

cinar · Oct 30, 2024 · 0cb0baf · 0cb0baf
1 parent 0c362a1
commit 0cb0baf
Show file tree

Hide file tree

Showing 35 changed files with 9 additions and 874 deletions.
diff --git a/.gomarkdoc.yml b/.gomarkdoc.yml
@@ -0,0 +1,3 @@
+output: "{{.Dir}}/README.md"
+repository:
+  url: https://github.com/cinar/checker
diff --git a/README.md b/README.md
@@ -141,6 +141,8 @@ type User struct {
 }
 ```
 
+<!-- gomarkdoc:embed -->
+
 # Contributing to the Project
 
 Anyone can contribute to Checkers library. Please make sure to read our [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md) guide first. Follow the [How to Contribute to Checker](./CONTRIBUTING.md) to contribute.

diff --git a/doc/checkers/alphanumeric.md b/doc/checkers/alphanumeric.md
diff --git a/doc/checkers/ascii.md b/doc/checkers/ascii.md
diff --git a/doc/checkers/cidr.md b/doc/checkers/cidr.md
diff --git a/doc/checkers/credit_card.md b/doc/checkers/credit_card.md
diff --git a/doc/checkers/digits.md b/doc/checkers/digits.md
diff --git a/doc/checkers/email.md b/doc/checkers/email.md
diff --git a/doc/checkers/fqdn.md b/doc/checkers/fqdn.md
diff --git a/doc/checkers/ip.md b/doc/checkers/ip.md
diff --git a/doc/checkers/ipv4.md b/doc/checkers/ipv4.md
diff --git a/doc/checkers/ipv6.md b/doc/checkers/ipv6.md
diff --git a/doc/checkers/isbn.md b/doc/checkers/isbn.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -141,6 +141,8 @@ type User struct { @@
     }
     ```
+    <!-- gomarkdoc:embed -->
     # Contributing to the Project
     Anyone can contribute to Checkers library. Please make sure to read our [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md) guide first. Follow the [How to Contribute to Checker](./CONTRIBUTING.md) to contribute.
@@ Expand Down @@