From f7b3bc43e41f39730b0b5d10827bd9e6a7698622 Mon Sep 17 00:00:00 2001 From: Shivam Sharma Date: Tue, 15 Oct 2024 15:36:03 +0530 Subject: [PATCH] docs: create document side with docsify --- docs/.nojekyll | 0 docs/_404.md | 6 ++++ docs/_navbar.md | 0 docs/_sidebar.md | 11 ++++++++ docs/guide/installation.md | 15 ++++++++++ docs/home.md | 46 ++++++++++++++++++++++++++++++ docs/index.html | 58 ++++++++++++++++++++++++++++++++++++++ 7 files changed, 136 insertions(+) create mode 100644 docs/.nojekyll create mode 100644 docs/_404.md create mode 100644 docs/_navbar.md create mode 100644 docs/_sidebar.md create mode 100644 docs/guide/installation.md create mode 100644 docs/home.md create mode 100644 docs/index.html diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/_404.md b/docs/_404.md new file mode 100644 index 0000000..acff0b3 --- /dev/null +++ b/docs/_404.md @@ -0,0 +1,6 @@ +

Error 404

+
+

+ The page you are looking for doesn’t exists.

+ Please check your URL address. +

diff --git a/docs/_navbar.md b/docs/_navbar.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/_sidebar.md b/docs/_sidebar.md new file mode 100644 index 0000000..10e2a5f --- /dev/null +++ b/docs/_sidebar.md @@ -0,0 +1,11 @@ +
+Welcome + +- [Introduction](./home.md) +- [Installation](./guide/installation.md) +
+ +
+How to Use + +
diff --git a/docs/guide/installation.md b/docs/guide/installation.md new file mode 100644 index 0000000..0830491 --- /dev/null +++ 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 new file mode 100644 index 0000000..a0577e5 --- /dev/null +++ b/docs/home.md @@ -0,0 +1,46 @@ +
+

World-Clockify

+ Node.js CI +npm version +GitHub issues +GitHub license +
+
+ +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. + + + +
+ +
+

Don't forget to ⭐ this repo

+

Building with the COMMUNITY for the COMMUNITY ❤️

+

Check out the full list of contributors who helped make this project awesome.

+
diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..6477913 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,58 @@ + + + + + World Clockify | Documentation + + + + + + + + + +
+ + + + + + + + + + + + + + +