docs: create document side with docsify

shivam-sharma7 · Oct 15, 2024 · f7b3bc4 · f7b3bc4
1 parent fe7c2d1
commit f7b3bc4
Show file tree

Hide file tree

Showing 7 changed files with 136 additions and 0 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_404.md b/docs/_404.md
@@ -0,0 +1,6 @@
+<h1 align='center'>Error 404</h1>
+<br>
+<p align='center'>
+    The page you are looking for doesn’t exists.<br><br>
+    Please check your URL address.
+</p>
diff --git a/docs/_navbar.md b/docs/_navbar.md
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,11 @@
+<details open style="margin-left: 33px">
+<summary>Welcome</summary>
+
+- [Introduction](./home.md)
+- [Installation](./guide/installation.md)
+</details>
+
+<details  open style="margin-left: 33px">
+<summary>How to Use</summary>
+
+</details>
diff --git a/docs/guide/installation.md b/docs/guide/installation.md
@@ -0,0 +1,15 @@
+## Installation
+
+First, you need to download node.js 20+ [Download Node.js](https://nodejs.org/en/download/).
+
+Then You can install the package via npm or yarn.
+
+```bash
+npm install world-clockify
+```
+
+or yarn
+
+```bash
+yarn add world-clockify
+```
diff --git a/docs/home.md b/docs/home.md
@@ -0,0 +1,46 @@
+ <div align="center" style="margin-top: 20px">    
+ <h1>World-Clockify</h1>
+ <a href="https://github.com/shivam-sharma7/world-clockify/actions/workflows/ci.yml"><img alt="Node.js CI" src="https://github.com/shivam-sharma7/world-clockify/actions/workflows/ci.yml/badge.svg"></a>
+<a href="https://www.npmjs.com/package/world-clockify"><img alt="npm version" src="https://img.shields.io/npm/v/world-clockify"></a>
+<a href="https://github.com/shivam-sharma7/world-clockify/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/shivam-sharma7/world-clockify"></a>
+<a href="./LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/shivam-sharma7/world-clockify"></a>
+</div>
+<br/>
+
+This is a lightweight and timezone-aware date utility package built on top of the powerful Luxon library. It simplifies the handling of complex timezone-based date operations, making it especially useful for global teams managing scheduling across multiple timezones.
+
+## Key Features
+
+- Convert date/time between different timezones. (e.g. Asia/Kolkata).
+- Get the current time in any timezone. (e.g., Asia/Kolkata)
+- Calculate the time difference (in hours) between two timezones.
+- Supports for both JavaScript and TypeScript developer.
+
+## Why world-clockify?
+
+### Ease of Use
+
+This library provides a simple and intuitive API for handling timezone-based date operations, making it easy for developers to integrate into their projects.
+
+### Lightweight
+
+Designed to be lightweight, this library minimizes the impact on your application's performance while providing essential timezone functionalities.
+
+### Versatile
+
+Whether you're building a global application or managing scheduling across multiple timezones, this library offers the tools you need to handle complex date operations with ease.
+
+### TypeScript Support
+
+With full TypeScript support, you can enjoy type safety and better development experience, reducing the likelihood of runtime errors.
+
+<!-- ## Authors
+<img src="https://contrib.rocks/image?repo=shivam-sharma7/world-clockify" /> -->
+
+<br/>
+
+<div align="center">
+    <h3>Don't forget to ⭐ this repo</h3>
+    <h4>Building with the COMMUNITY for the COMMUNITY ❤️</h4>
+      <p>Check out the <a href="https://github.com/shivam-sharma7/world-clockify/graphs/contributors">full list of contributors</a> who helped make this project awesome.</p>
+</div>
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,58 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>World Clockify | Documentation</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta
+      name="description"
+      content="World Clockify is a lightweight and timezone-aware date utility package built on top of the powerful Luxon library. It simplifies the handling of complex timezone-based date operations, making it especially useful for global teams managing scheduling across multiple timezones."
+    />
+    <meta
+      name="keywords"
+      content="timezone, date utility, Luxon, JavaScript, TypeScript, global scheduling, time conversion, time difference, world clock"
+    />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0" />
+    <!-- Theme: Simple Dark -->
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css" />
+  </head>
+
+  <body>
+    <div id="app"></div>
+    <script>
+      window.$docsify = {
+        search: 'auto',
+        loadSidebar: '_sidebar.md',
+        loadNavbar: true,
+        name: 'world-clockify',
+        repo: 'https://github.com/shivam-sharma7/world-clockify',
+        themeColor: 'red',
+        notFoundpage: './_404.md',
+        homepage: 'home.md',
+        share: {
+          linkedin: true,
+          twitter: true,
+          whatsapp: true,
+          telegram: true,
+          reddit: true,
+        },
+        progress: {
+          height: '5px',
+          color: 'var(--theme-color,#42b983)',
+        },
+      };
+    </script>
+    <!-- Docsify v4 -->
+    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+    <script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
+    <script src="//unpkg.com/docsify-share/build/index.min.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+
+    <!-- Normalize path text search (e.g., "cafe" will also match "café"). -->
+    <script src="//polyfill.io/v3/polyfill.min.js?features=String.prototype.normalize"></script>
+
+    <script src="https://cdn.jsdelivr.net/npm/docsify-progress@latest/dist/progress.min.js"></script>
+
+    <script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
+  </body>
+</html>