# @canopassoftware/canopas-blog-components

> Canopas blog components

Latest version **1.1.3** (published 2024-02-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @canopassoftware/canopas-blog-components
pnpm add @canopassoftware/canopas-blog-components
yarn add @canopassoftware/canopas-blog-components
bun add @canopassoftware/canopas-blog-components
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2024-02-01 |
| First published | 2023-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 670.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 33 |
| Author | canopassoftware |
| Maintainers | cp-ashish-k, dharti-canopas, sumita, canopasinc |
| Keywords | components, component library, nuxt library, nuxt module, canopas |

## Links

- npm: https://www.npmjs.com/package/@canopassoftware/canopas-blog-components
- Repository: https://github.com/canopas/canopas-blog-components
- Homepage: https://github.com/canopas/canopas-blog-components#readme
- Issues: https://github.com/canopas/canopas-blog-components/issues
- npm.io page: https://npm.io/package/@canopassoftware/canopas-blog-components

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^1.5.1
- [pinia](https://npm.io/package/pinia.md) ^2.1.7
- [@nuxt/kit](https://npm.io/package/@nuxt/kit.md) ^3.7.4
- [nuxt-icon](https://npm.io/package/nuxt-icon.md) ^0.5.0
- [@pinia/nuxt](https://npm.io/package/@pinia/nuxt.md) ^0.5.0

## Recent versions

- 1.1.3 (latest) — 2024-02-01
- 1.1.2 — 2024-01-31
- 1.1.1 — 2024-01-29
- 1.1.0 — 2024-01-24
- 1.0.9 — 2024-01-23
- 1.0.8 — 2024-01-23
- 1.0.7 — 2024-01-16
- 1.0.6 — 2023-11-04
- 1.0.5 — 2023-10-31
- 1.0.4 — 2023-10-30
- 1.0.3 — 2023-10-27
- 1.0.2 — 2023-10-27
- 1.0.1 — 2023-10-26
- 1.0.0 — 2023-10-26

## README

# Blog Components

Welcome to the `blog-components` library, a component library for [**canopas blogs website**](https://canopas.com/resources).


## About

The `blog-components` is an open-source library developed and maintained by Canopas. Crafted using `vue.js` and `tailwindcss` a lightweight and highly efficient CSS platform on top of `Nuxt 3` framework, showcasing a commitment to robust and advanced web development practices. For preview visit [**_canopas blogs page_**](https://canopas.com/resources) .

## Showcase

#### Blogs List UI

![Blog List UI](https://github.com/canopas/canopas-blog/assets/69897605/10747407-ada8-40fc-b23c-fa965c0bc33a)

#### Blogs Detail UI

![Blog Detail UI](https://github.com/canopas/canopas-blog/assets/69897605/bf24fbb5-9771-495a-a553-1c54e0b271d7)
## Prerequisites

Prior to integrating `blog-components` into your project, please ensure that `tailwindcss` is installed and properly configured within your project environment.

## Quick Setup

1. Add `blog-components` dependency to your project .

### Using yarn :

```bash
yarn add --dev @canopassoftware/canopas-blog-components
```

### Using npm :

```bash
npm install --save-dev @canopassoftware/canopas-blog-components
```

<br>

2. Add `blog-components` to the `modules` section of `nuxt.config.ts`

```js
export default defineNuxtConfig({
  modules: [
    "@canopassoftware/canopas-blog-components"
  ],
});
```

That's it! You can now use module in your Nuxt app ✨

Here are the examples,

```js
For all blog list,

  <BlogList :showDrafts="true" />

For tag list,
  <TagList :slug="slug" @notfound="<your-callback>" :showDrafts="true"  />


For Blog details,
  <BlogDetail
      :slug="slug"
      @notfound="<your-callback>"
      :showDrafts="true"
      :iframely-key="IFRAMELY_KEY"
      :recaptcha-key="RECAPTCHA_SITE_KEY"
    />

```
<br>

# Steps to Run the component 

## Install dependencies


```bash
yarn install 
```
#### To initialize the Nuxt repo :
```bash
npx nuxi prepare
```
## To create output.css file
``` bash
yarn prepack
```
- Copy `output.css` file from `.dist/` folder and paste inside the `src` folder
## Start component in dev mode using :

```bash
yarn dev 
```
## Compiles and minifies for production :

```bash
yarn dev:build 
```
```bash
yarn generate
```
You can access the page by pointing a web browser at http://localhost:3000

 <br > 

# LICENSE

This repository licenced under [MIT](https://github.com/canopas/canopas-blog-components/blob/main/LICENSE).

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