Feat/23 documentation (#24)

* documentation * set homepage * formatting
infinitaslearning · Dec 9, 2024 · 2b46db6 · 2b46db6
1 parent aecff4f
commit 2b46db6
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -2,5 +2,6 @@ dist/
 coverage/
 node_modules/
 .vscode/
+.DS_Store
 
 .eslintcache
diff --git a/.npmignore b/.npmignore
@@ -2,6 +2,7 @@
 .husky/
 scripts/
 test/
+docs/
 
 .eslintcache
 biome.json

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>@ilpt/systemic-ts - A minimal type-safe dependency injection library</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="A minimal type-safe dependency injection library">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify-themeable/dist/css/theme-simple.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: '@ilpt/systemic-ts',
+      repo: 'https://github.com/infinitaslearning/systemic-ts',
+      homepage: 'https://raw.githubusercontent.com/infinitaslearning/systemic-ts/refs/heads/main/README.md',
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+  <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
+  <!-- To enable syntax highlighting on TypeScript codes: -->
+  <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"></script>
+</body>
+</html>
diff --git a/package.json b/package.json
@@ -65,7 +65,7 @@
   "bugs": {
     "url": "https://github.com/infinitaslearning/systemic-ts/issues"
   },
-  "homepage": "https://github.com/infinitaslearning/systemic-ts#readme",
+  "homepage": "https://infinitaslearning.github.io/systemic-ts",
   "dependencies": {
     "@types/toposort": "^2.0.7",
     "debug": "^4.3.5",
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,6 +2,7 @@ @@
     .husky/
     scripts/
     test/
+    docs/
     .eslintcache
     biome.json
@@ Expand Down @@