https://github.com/debonex/guiderjs
Customizable and animated library for creating user guide on your website.
https://github.com/debonex/guiderjs
guide intro javascript react typescript ui-library user-guide vue vue3
Last synced: 2 months ago
JSON representation
Customizable and animated library for creating user guide on your website.
- Host: GitHub
- URL: https://github.com/debonex/guiderjs
- Owner: Debonex
- License: mit
- Created: 2022-12-06T08:08:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-18T08:31:45.000Z (over 3 years ago)
- Last Synced: 2024-04-24T16:36:49.250Z (about 2 years ago)
- Topics: guide, intro, javascript, react, typescript, ui-library, user-guide, vue, vue3
- Language: TypeScript
- Homepage: https://Debonex.github.io/guiderjs
- Size: 1.41 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Guiderjs
A customizable and animated library for creating guide on your website.
[Document](https://debonex.github.io/guiderjs)
## Features
- 📦 Modern bundle
- 👌 Easy to use
- 🏳🌈 Support major frameworks (React,Vue)
- ⚡ Lightweight
- 🚧 Typescript support
- ✨ Customizable
## Get started
- [Vanilla](https://debonex.github.io/guiderjs/docs/react/Get%20started)
- [React](packages/react/README.md)
- [Vue3](packages/vue3/README.md)
## Development
Run the flowing commands to develop locally. (use `pnpm v7` to manage packages and workspace.)
```shell
$ pnpm i
# Build core module
$ pnpm build
$ pnpm dev
```
If you need hot module load of core module, import from "@core/index" instead of "@guiderjs/core", then you can skip pnpm build
### Develop docs
```shell
$ pnpm dev:docs
```