diff --git a/.gitignore b/.gitignore index 584ea00..a21090c 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,7 @@ output.* # IDE .idea .vscode + +!docs/*.html +!docs/*.txt +!docs/*.xml \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..9ae68c3 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,113 @@ + + + + + + + + + + + + + + + + + + + + docs-code — Russian document codes for Go + + + + + + +
+
+

GO LIBRARY

+

Russian document codes,
without the ceremony.

+

Validate and generate the codes your Go application needs.

+ +
+ +
+
+

SUPPORTED CODES

+

The essentials, covered.

+
+ +

OKATO format and hierarchy validation is also available. Existence lookup and generation are not implemented.

+
+ +
+
+

USAGE

+

A small API.

+
+
+
+

Install

+
go get github.com/sshaplygin/docs-code
+
+
+

Validate

+
valid, err := docs_code.Validate(
+  docs_code.INN,
+  "526317984689",
+)
+
+
+

Generate

+
code, err := docs_code.Generate(
+  docs_code.SNILS,
+)
+
+
+
+ +
+
+

MORE CONTROL

+

Need a specific operation?

+
+

Each document type is available as a focused package. Use it directly when your integration needs more than the common API.

+ Explore packages +
+
+ + + + diff --git a/docs/robots.txt b/docs/robots.txt new file mode 100644 index 0000000..f53379c --- /dev/null +++ b/docs/robots.txt @@ -0,0 +1,4 @@ +User-agent: * +Allow: / + +Sitemap: https://sshaplygin.github.io/docs-code/sitemap.xml diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 0000000..6021124 --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,6 @@ + + + + https://sshaplygin.github.io/docs-code/ + +