Move the documentation to the GitHub wiki

mc2it · Jun 16, 2024 · 1578cb5 · 1578cb5
1 parent d5d86b5
commit 1578cb5
Show file tree

Hide file tree

Showing 12 changed files with 419 additions and 291 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
diff --git a/README.md b/README.md
@@ -1,15 +1,16 @@
 # MC2IT Card
 ![Node.js](https://badgen.net/npm/node/@mc2it/card) ![npm](https://badgen.net/npm/v/@mc2it/card) ![License](https://badgen.net/npm/license/@mc2it/card) ![Downloads](https://badgen.net/npm/dt/@mc2it/card)
 
-Business card of MC2IT, distribution and services, implemented in [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript).
+Business card of MC2IT, distribution and services,
+implemented in [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript).
 
 ## Usage
 Before you start, you need to make sure you have [Node.js](https://nodejs.org) up and running.
 You can verify if you're already good to go with the following command:
 
 ```shell
 node --version
-# v22.0.0
+# v22.3.0
 ```
 
 Then, to display the business card, just type the following command in your terminal:
@@ -21,10 +22,8 @@ npx @mc2it/card
 And voila!
 
 ## See also
-- [API reference](https://mc2it.github.io/card/api)
 - [Git repository](https://github.com/mc2it/card)
-- [npm package](https://www.npmjs.com/package/@mc2it/card)
 - [Submit an issue](https://github.com/mc2it/card/issues)
 
 ## License
-[MC2IT Card](https://mc2it.github.io/card) is distributed under the MIT License.
+[MC2IT Card](https://github.com/mc2it/card) is distributed under the MIT License.
diff --git a/docs/favicon.ico b/docs/favicon.ico
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/logo.svg b/docs/logo.svg
diff --git a/docs/styles.css b/docs/styles.css
diff --git a/etc/mkdocs.yaml b/etc/mkdocs.yaml
diff --git a/etc/requirements.txt b/etc/requirements.txt
diff --git a/etc/typedoc.js b/etc/typedoc.js
diff --git a/gulpfile.js b/gulpfile.js
@@ -1,4 +1,3 @@
-import {cp} from "node:fs/promises";
 import {deleteAsync} from "del";
 import {$} from "execa";
 import gulp from "gulp";
@@ -14,12 +13,6 @@ export function clean() {
 	return deleteAsync(["lib", "var/**/*", "www"]);
 }
 
-// Builds the documentation.
-export async function doc() {
-	for (const file of ["CHANGELOG.md", "LICENSE.md"]) await cp(file, `docs/${file.toLowerCase()}`);
-	return $`typedoc --options etc/typedoc.js`;
-}
-
 // Performs the static analysis of source code.
 export async function lint() {
 	await $`tsc --project tsconfig.json`;
@@ -31,12 +24,6 @@ export async function publish() {
 	for (const action of [["tag"], ["push", "origin"]]) await $`git ${action} v${pkg.version}`;
 }
 
-// Starts the development server.
-export async function serve() {
-	await doc();
-	return $({stdio: "inherit"})`mkdocs serve --config-file=etc/mkdocs.yaml`;
-}
-
 // The default task.
 export default gulp.series(
 	clean,