docs(core): add mkdocs for documentation site (#10)

added and configured mkdocs for documentation site
added and configured typedoc for exporting api references as markdown files inside mkdocs's docs_dir
added `ci.yml` in github workflow to deploy documentation site on every push to master branch.

GH-9

Author: shubhamp-sf

.eslintignore

@@ -4,3 +4,5 @@ coverage/
 .eslintrc.js
 .cz-config.js
 commitlint.config.js
+docs/
+site/

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - name: Setup Node
+        uses: actions/setup-node@v3.6.0
+        with:
+          node-version: '18.x'
+      - name: Bootstrap
+        run: npm ci
+      - name: Install mkdocs deps/plugins
+        run: |
+          pip install mkdocs-material
+          pip install mkdocs-include-markdown-plugin
+      - name: Create the docs directory locally in CI
+        run: npx typedoc
+      - name: Deploy 🚀
+        run: mkdocs gh-deploy --force

.gitignore

@@ -63,4 +63,11 @@ typings/
 # Cache used by TypeScript's incremental build
 *.tsbuildinfo
 
-/src/sequelize/usercrud.sequelize.repository.base.ts
+/src/sequelize/usercrud.sequelize.repository.base.ts
+
+# site contains compiled html files, we don't need them because mkdocs-deploy
+# can freshly recreate them
+/site
+
+# api-reference
+/docs/api-reference

.prettierignore

@@ -1,2 +1,4 @@
 dist
 *.json
+docs
+site

README.md

@@ -2,6 +2,8 @@
 
 [![LoopBack](<https://github.com/loopbackio/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)-@2x.png>)](http://loopback.io/)
 
+<!-- docs-index-start -->
+
 This is a loopback4 extension that provides Sequelize's query builder at repository level in any loopback 4 application. It has zero learning curve as it follows similar interface as `DefaultCrudRepository`. For relational databases, Sequelize is a popular ORM of choice.
 
 For pending features, refer to the [Limitations](#limitations) section below.
@@ -30,13 +32,15 @@ npm install --save oracledb # Oracle Database
 
 > You can watch a video overview of this extension by [clicking here](https://youtu.be/ZrUxIk63oRc).
 
+<!-- tutorial-start -->
+
 Both newly developed and existing projects can benefit from the extension by simply changing the parent classes in the target Data Source and Repositories.
 
 ### Step 1: Configure DataSource
 
 Change the parent class from `juggler.DataSource` to `SequelizeDataSource` like below.
 
-```ts
+```ts title="pg.datasource.ts"
 // ...
 import {SequelizeDataSource} from 'loopback4-sequelize';
 
@@ -52,7 +56,7 @@ export class PgDataSource
 
 Change the parent class from `DefaultCrudRepository` to `SequelizeCrudRepository` like below.
 
-```ts
+```ts title="your.repository.ts"
 // ...
 import {SequelizeCrudRepository} from 'loopback4-sequelize';
 
@@ -104,6 +108,8 @@ An example of the filter object might look like this to fetch the books who cont
 }
 ```
 
+<!-- tutorial-end -->
+
 ## Debug strings reference
 
 There are three built-in debug strings available in this extension to aid in debugging. To learn more about how to use them, see [this page](https://loopback.io/doc/en/lb4/Setting-debug-strings.html).
@@ -163,3 +169,5 @@ Code of conduct guidelines [here](https://github.com/sourcefuse/loopback4-sequel
 ## License
 
 [MIT](https://github.com/sourcefuse/loopback4-sequelize/blob/master/LICENSE)
+
+<!-- docs-index-end -->

docs/index.md

@@ -0,0 +1,9 @@
+---
+title: Overview
+---
+
+{%
+   include-markdown "../README.md"
+   start="<!-- docs-index-start -->"
+   end='<!-- docs-index-end -->'
+%}

docs/tutorial/index.md

@@ -0,0 +1,7 @@
+# Basics
+
+{%
+   include-markdown "../../README.md"
+   start="<!-- tutorial-start -->"
+   end='<!-- tutorial-end -->'
+%}

mkdocs.yml

@@ -0,0 +1,41 @@
+site_name: Loopback4 Sequelize
+
+theme:
+  name: material
+  features:
+    - content.code.copy
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+docs_dir: docs
+
+markdown_extensions:
+  - tables
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+extra:
+  generator: false
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/sourcefuse/loopback4-sequelize
+
+plugins:
+  - search
+  - include-markdown
+
+repo_name: sourcefuse/loopback4-sequelize
+repo_url: https://github.com/sourcefuse/loopback4-sequelize
+
+copyright: |
+  &copy; 2023 <a href="https://github.com/sourcefuse/loopback4-microservice-catalog" target="_blank" rel="noopener">Sourceloop</a>