# @tereza-tech/zettel

> Create your own digital garden with Zettel, an open source engine that implements the [Zettelkasten method](https://arantespp.com/zettel/zettelkasten).

Latest version **0.25.0** (published 2023-08-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @tereza-tech/zettel
pnpm add @tereza-tech/zettel
yarn add @tereza-tech/zettel
bun add @tereza-tech/zettel
```

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.25.0 |
| Published | 2023-08-26 |
| First published | 2022-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 7 |
| Unpacked size | 96.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tereza Tech |
| Maintainers | pedro-arantes |

## Links

- npm: https://www.npmjs.com/package/@tereza-tech/zettel
- npm.io page: https://npm.io/package/@tereza-tech/zettel

## Dependencies (7)

- [date-fns](https://npm.io/package/date-fns.md) ^2.30.0
- [title-case](https://npm.io/package/title-case.md) ^3.0.3
- [change-case](https://npm.io/package/change-case.md) ^4.1.2
- [gray-matter](https://npm.io/package/gray-matter.md) ^4.0.3
- [reading-time](https://npm.io/package/reading-time.md) ^1.5.0
- [@ttoss/config](https://npm.io/package/@ttoss/config.md) ^1.30.6
- [@aws-sdk/client-s3](https://npm.io/package/@aws-sdk/client-s3.md) ^3.304.0

## Recent versions

- 0.25.0 (latest) — 2023-08-26
- 0.23.2 — 2023-05-15
- 0.23.1 — 2023-04-23
- 0.23.0 — 2023-04-07
- 0.22.1 — 2023-04-03
- 0.22.0 — 2023-03-27
- 0.21.0 — 2023-03-13
- 0.20.0 — 2023-02-19
- 0.19.0 — 2023-02-07
- 0.18.0 — 2023-02-07
- 0.17.0 — 2023-02-06
- 0.16.1 — 2023-02-04
- 0.16.0 — 2023-01-31
- 0.15.1 — 2023-01-27
- 0.15.0 — 2023-01-26
- … 14 more at https://npm.io/package/@tereza-tech/zettel/versions

## README

# Zettel

Create your own digital garden with Zettel, an open source engine that implements the [Zettelkasten method](https://arantespp.com/zettel/zettelkasten).

## Installation

```bash
yarn add @tereza-tech/zettel
```

## Quickstart

Create your Zettelkasten notes in a folder, for example `notes`, then instantiate your Zettelkasten engine:

```ts
import { Zettelkasten } from '@tereza-tech/zettel';
import * as path from 'path';

const notesDir = path.join(process.cwd(), 'notes');

const zettelkasten = new Zettelkasten({ notesDir });

(async () => {
  const notes = await zettelkasten.getNotes();

  const blogNote = await zettelkasten.getNotes({ groups: ['blog'] });

  const tags = await zettelkasten.getTags();

  const flashcard = await zettelkasten.getFlashcard();

  const graph = await zettelkasten.getGraphData();
})();
```

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