Initial commit

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "yzhang.markdown-all-in-one",
+    "davidanson.vscode-markdownlint",
+    "fabiospampinato.vscode-terminals"
+  ]
+}

.vscode/terminals.json

@@ -0,0 +1,16 @@
+{
+  "autorun": true,
+  "autorun_delay": 500,
+  "auto_kill": true,
+  "terminals": [
+    {
+      "name": "Serve Docs",
+      "description": "Documentation server",
+      "focus": true,
+      "execute": true,
+      "recycle": true,
+      "commands": ["npx docsify serve docs --port 1000"],
+      "color": "terminal.ansiGreen"
+    }
+  ]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Awesome Templates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,21 @@
+# docsify-starter
+
+Quick **[docsify](https://docsify.js.org/)** starter template.
+
+## 📦 Installation
+
+First install docsify CLI
+
+```bash
+npm i docsify-cli -g
+```
+
+## 🚀 Serve Docs
+
+Start `docs` project
+
+```bash
+npx docsify serve docs --port 1000
+```
+
+To configure docsify see [index.html](./docs/index.html#L20) file.

docs/.markdownlint.json

@@ -0,0 +1,6 @@
+{
+  "MD013": false,
+  "MD033": false,
+  "MD051": false,
+  "MD041": false
+}

docs/README.md

@@ -0,0 +1,9 @@
+# My Awesome Project
+
+Enim nostrud ut deserunt sit deserunt veniam. Ullamco culpa Lorem Lorem voluptate minim consectetur consectetur dolor adipisicing. Lorem aliquip minim in non Lorem incididunt. Aute nulla proident sunt consequat ut ad enim consectetur incididunt sit. Incididunt laborum fugiat dolor laborum ullamco exercitation nisi. Esse ut incididunt commodo mollit esse dolor excepteur quis occaecat proident cupidatat fugiat dolor. Occaecat occaecat tempor amet irure exercitation consectetur incididunt occaecat veniam sint aliquip eiusmod.
+
+Pariatur voluptate Lorem elit minim quis et tempor aliqua adipisicing enim. Excepteur laborum aliqua et do eu commodo nostrud reprehenderit cupidatat. Et fugiat ex pariatur velit aliquip laboris dolore reprehenderit aliquip commodo commodo Lorem ullamco excepteur. Fugiat fugiat excepteur voluptate commodo occaecat et. Duis dolore occaecat duis velit ea magna ullamco eiusmod.
+
+Ea irure ea consectetur fugiat eu magna officia veniam labore duis eiusmod velit. Nostrud enim laborum eiusmod nulla Lorem incididunt sunt officia aliquip cillum. Nostrud consectetur excepteur culpa pariatur excepteur enim laborum nulla pariatur quis irure non exercitation. Cupidatat velit veniam qui fugiat enim irure ipsum magna sint nulla ex consectetur enim tempor. Eu irure irure occaecat qui exercitation amet exercitation irure cillum reprehenderit reprehenderit.
+
+Elit laborum dolor pariatur pariatur cupidatat culpa amet exercitation nostrud sit magna aliquip eiusmod irure. Exercitation qui consectetur adipisicing excepteur commodo dolor sunt anim commodo duis ullamco cillum irure. Culpa ea reprehenderit duis tempor non fugiat labore incididunt velit officia magna. Deserunt adipisicing excepteur sint enim eiusmod officia excepteur elit consequat consequat est proident consequat. Ea officia nisi culpa do dolor deserunt velit sunt id enim exercitation dolore cillum aliquip.

docs/_coverpage.md

@@ -0,0 +1,6 @@
+# Docsify Starter 💗
+
+> Quick docsify starter template
+
+[GitHub](https://github.com/awe-templates/docsify-starter)
+[Quick Start](/pages/quick-start)

docs/_sidebar.md

@@ -0,0 +1,2 @@
+* [Home](/)
+* [Quick Start](pages/quick-start.md)

docs/index.html

@@ -0,0 +1,85 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Document</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="description" content="Description" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+
+    <link rel="icon" href="https://fav.farm/📚" />
+
+    <link
+      rel="stylesheet"
+      media="(prefers-color-scheme: dark)"
+      href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css"
+    />
+    <link
+      rel="stylesheet"
+      media="(prefers-color-scheme: light)"
+      href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css"
+    />
+  </head>
+
+  <body>
+    <div id="app"></div>
+
+    <script>
+      window.$docsify = {
+        name: "docsify-starter",
+        repo: "awe-templates/docsify-starter",
+        loadSidebar: true,
+        subMaxLevel: 5,
+        coverpage: true,
+        // auto2top: true,
+
+        // plugin: copy to clipboard
+        copyCode: {
+          buttonText: "Copy",
+          errorText: "Error",
+          successText: "Copied",
+        },
+
+        // plugin: pagination
+        pagination: {
+          previousText: "Previous",
+          nextText: "Next",
+          crossChapter: true,
+          crossChapterText: true,
+        },
+
+        plugins: [
+          titlePlugin({
+            suffix: ` | ${document.getElementsByTagName("title")[0].text}`,
+          }),
+        ],
+      };
+
+      // @source: https://github.com/docsifyjs/docsify/issues/540#issuecomment-884447568
+      function titlePlugin(config) {
+        return (hook, vm) => {
+          hook.doneEach((content) => {
+            document.title += config.suffix;
+          });
+        };
+      }
+    </script>
+
+    <!-- Docsify -->
+    <script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
+
+    <!-- Recommended -->
+    <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
+
+    <!-- Plugin: Copy to Clipboard -->
+    <script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
+
+    <!-- Plugin: Pagination -->
+    <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
+  </body>
+</html>

docs/pages/quick-start.md

@@ -0,0 +1,33 @@
+# Quick Start
+
+- [Quick Start](#quick-start)
+  - [📦 Installation](#-installation)
+  - [🚀 Usage](#-usage)
+  - [📚 Learn More](#-learn-more)
+
+Duis et occaecat occaecat esse pariatur ut eu ut in sint eu. Laborum officia reprehenderit dolore nostrud consectetur ipsum. Deserunt mollit irure fugiat amet. Quis id ullamco aliquip excepteur incididunt sunt esse. Officia exercitation incididunt eiusmod amet in quis anim esse in elit incididunt.
+
+## 📦 Installation
+
+```bash
+npm i @my/awesome-package
+
+# or
+
+pnpm i @my/awesome-package
+```
+
+## 🚀 Usage
+
+```typescript
+import { AwesomeModule } from '@my/awesome-package';
+
+...AwesomeModule.startNewDay()
+```
+
+## 📚 Learn More
+
+- [What is Turbopack](https://www.youtube.com/watch?v=6ZwnBI4Rb1w)
+- [Is TurboPack using SWC under the hood?](https://github.com/vercel/turbo/discussions/2350#discussioncomment-3965562)
+- [Redux DevTools Extension](https://github.com/reduxjs/redux-devtools)
+- [Prisma ORM](https://www.prisma.io/orm)