summaryrefslogtreecommitdiff
path: root/doc/pages/index.mdx
diff options
context:
space:
mode:
authorNicolas Paul <n@nc0.fr>2023-10-03 09:38:59 +0200
committerNicolas Paul <n@nc0.fr>2023-10-03 16:00:05 +0200
commitc7313a361d69efc4853c17c18d1591cd5f891648 (patch)
treedab0cb499ce87ccca4f4358f33bbcdafaa537eb1 /doc/pages/index.mdx
parentc328105d017a8ef4918a5078519d5eb907d1174a (diff)
Move installation information inside the index
Diffstat (limited to 'doc/pages/index.mdx')
-rw-r--r--doc/pages/index.mdx30
1 files changed, 27 insertions, 3 deletions
diff --git a/doc/pages/index.mdx b/doc/pages/index.mdx
index 1e2f4a7..cd0938c 100644
--- a/doc/pages/index.mdx
+++ b/doc/pages/index.mdx
@@ -53,11 +53,35 @@ For illustration, imagine you are using `example.com/foo` as a dependency,
whose main origin is on GitHub. If suddenly the origin is moved to GitLab
(for some particular reason), it will be transparent to you.
+## How Does it Work?
+
+SVGU works by generating a set of HTML files containing the
+required meta tags (incl.
+[`go-source`](https://github.com/golang/gddo/wiki/Source-Code-Links) and
+[`go-import`](https://go.dev/blog/publishing-go-modules)) by the standard Go
+toolchain. These documents also redirects users to the
+[Go documentation service](https://pkg.go.dev) for the requested module.
+
+The resulting directory of files can be hosted on any web server, with the only
+required configuration to rewrite URLs to remove the `.html` prefix (some
+call this behavior "Pretty URLs").
+
+> Here are links to various popular web servers enabling URL rewriting:
+> [Apache HTTPD](https://httpd.apache.org/docs/current/rewrite/remapping.html),
+> [Caddy](https://caddyserver.com/docs/caddyfile/directives/rewrite),
+> [NGINX](https://www.nginx.com/blog/creating-nginx-rewrite-rules/),
+> [Cloudflare Pages](https://pages.cloudflare.com) and
+> [GitHub Pages](https://pages.github.com/) do this by default,
+> ...
+
+## Installation
+
## Licensing
-SVGU is a free software, available under the CeCILL 2.1 license contract.
-This documentation is available under the Creative Commons
-Attribution-ShareAlike 4.0 license.
+SVGU is a free software, available under the
+[CeCILL 2.1 license](https://cecill.info) contract.
+This documentation is available under the
+[Creative Commons Attribution-ShareAlike 4.0 license](https://creativecommons.org/licenses/by-sa/4.0/).
Please see the [repository](https://github.com/nc0fr/svgu) for complete
details.