diff options
| -rw-r--r-- | doc/pages/_meta.json | 1 | ||||
| -rw-r--r-- | doc/pages/index.mdx | 30 | ||||
| -rw-r--r-- | doc/pages/install.mdx | 45 | ||||
| -rw-r--r-- | doc/theme.config.tsx | 6 |
4 files changed, 27 insertions, 55 deletions
diff --git a/doc/pages/_meta.json b/doc/pages/_meta.json index 6ce1f13..4304e46 100644 --- a/doc/pages/_meta.json +++ b/doc/pages/_meta.json @@ -1,6 +1,5 @@ { "index": "Introduction", - "install": "Installation", "guide": "Example", "starlark": "Starlark Language", "references": "References" 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. diff --git a/doc/pages/install.mdx b/doc/pages/install.mdx deleted file mode 100644 index 14a22ff..0000000 --- a/doc/pages/install.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -# Copyright Nicolas (2023) -# -# * Nicolas Paul -# -# This software is a computer program whose purpose is to allow the hosting -# and sharing of Go modules using a personal domain. -# -# This software is governed by the CeCILL license under French law and -# abiding by the rules of distribution of free software. You can use, -# modify and/ or redistribute the software under the terms of the CeCILL -# license as circulated by CEA, CNRS and INRIA at the following URL -# "http://www.cecill.info". -# -# As a counterpart to the access to the source code and rights to copy, -# modify and redistribute granted by the license, users are provided only -# with a limited warranty and the software's author, the holder of the -# economic rights, and the successive licensors have only limited -# liability. -# -# In this respect, the user's attention is drawn to the risks associated -# with loading, using, modifying and/or developing or reproducing the -# software by the user in light of its specific status of free software, -# that may mean that it is complicated to manipulate, and that also -# therefore means that it is reserved for developers and experienced -# professionals having in-depth computer knowledge. Users are therefore -# encouraged to load and test the software's suitability as regards their -# requirements in conditions enabling the security of their systems and/or -# data to be ensured and, more generally, to use and operate it in the -# same conditions as regards security. -# -# The fact that you are presently reading this means that you have had -# knowledge of the CeCILL license and that you accept its terms. - -title: Installation -description: | - The installation procedures for the SVGU software on various operating - systems ad workflows. ---- - -# Installation - -Installing SVGU is pretty easy! - -TODO diff --git a/doc/theme.config.tsx b/doc/theme.config.tsx index 5e6e62c..e208a31 100644 --- a/doc/theme.config.tsx +++ b/doc/theme.config.tsx @@ -89,12 +89,6 @@ export default { ); }, darkMode: true, - nextThemes: { - defaultTheme: "system", - enableTheme: true, - enableColorScheme: true, - themes: [ "light", "dark" ] - }, logo: <span>SVGU</span>, logoLink: true, project: { |