# @guiderjs/core

> Customizable library for creating guide on your website. (Common logic)

Latest version **0.2.7** (published 2023-01-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @guiderjs/core
pnpm add @guiderjs/core
yarn add @guiderjs/core
bun add @guiderjs/core
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.7 |
| Published | 2023-01-18 |
| First published | 2022-12-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 36.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Debonex |
| Maintainers | debonex |

## Links

- npm: https://www.npmjs.com/package/@guiderjs/core
- Repository: https://github.com/Debonex/guiderjs
- Homepage: https://github.com/Debonex/guiderjs#readme
- Issues: https://github.com/Debonex/guiderjs/issues
- npm.io page: https://npm.io/package/@guiderjs/core

## Recent versions

- 0.2.7 (latest) — 2023-01-18
- 0.2.6 — 2023-01-18
- 0.2.5 — 2023-01-16
- 0.2.4 — 2023-01-13
- 0.2.3 — 2023-01-12
- 0.2.2 — 2023-01-12
- 0.2.1 — 2023-01-10
- 0.2.0 — 2023-01-05
- 0.1.1 — 2022-12-21
- 0.1.0 — 2022-12-21

## 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
```

---
_Source: https://npm.io/package/@guiderjs/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._