Merge pull request #3 from metaloha/add-docs

Add document generation via `npm run docs` command; updated dependencies

Author: metaloha

.eslintrc.json

@@ -3,7 +3,9 @@
   "ignorePatterns": [
     "**/*"
   ],
-  "plugins": [],
+  "plugins": [
+    "eslint-plugin-tsdoc"
+  ],
   "settings": {
     "import/resolver": {
       "typescript": {}
@@ -212,7 +214,8 @@
         "prefer-template": "error",
         "quotes": "off",
         "radix": "error",
-        "require-atomic-updates": "error"
+        "require-atomic-updates": "error",
+        "tsdoc/syntax": "warn"
       }
     }
   ]

docs/CODE_OF_CONDUCT.md renamed to CODE_OF_CONDUCT.md

@@ -5,10 +5,6 @@ Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in
 
 ## Development environment setup
 
-> **[?]**
-> Proceed to describe how to setup local development environment.
-> e.g:
-
 To set up a development environment, please follow these steps:
 
 1. Clone the repo
@@ -31,8 +27,7 @@ To set up a development environment, please follow these steps:
 
 ## Issues and feature requests
 
-You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue to our [GitHub Repository](https://github.com/metaloha/ts-boilerplate/issues). Before you create an issue, make sure you search the archive, maybe your question was already answered.
-Also please check out [GitHub discussions](https://github.com/metaloha/ts-boilerplate/discussions) before submitting an issue. 
+You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue to our [GitHub Repository](https://github.com/metaloha/ts-boilerplate/issues). Before you create an issue, make sure you search the archive, maybe your question was already answered. Also, please check out [GitHub discussions](https://github.com/metaloha/ts-boilerplate/discussions) before submitting an issue. 
 
 Please try to create bug reports that are:
 

docs/CONTRIBUTING.md renamed to CONTRIBUTING.md

@@ -19,7 +19,7 @@ Reach out to the maintainer at one of the following places:
 
 First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
 
-We have set up a separate document containing our [contribution guidelines](docs/CONTRIBUTING.md).
+We have set up a separate document containing our [contribution guidelines](CONTRIBUTING.md).
 
 Thank you for being involved!
 
@@ -34,7 +34,7 @@ For a full list of all authors and contributors, check [the contributor's page](
 TS-Boilerplate follows good practices of security, but 100% security can't be granted in software.
 TS-Boilerplate is provided **"as is"** without any **warranty**. Use at your own risk.
 
-_For more info, please refer to the [security](docs/SECURITY.md)._
+_For more info, please refer to the [security](SECURITY.md)._
 
 ## License
 

README.md

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/SECURITY.md renamed to SECURITY.md

@@ -0,0 +1,50 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #008000;
+    --dark-hl-3: #6A9955;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+pre, code { background: var(--code-background); }