# @prakashraman/notes

> ![Test Suite](https://github.com/prakashraman/notes/workflows/Test%20Suite/badge.svg?branch=main) ![](https://img.shields.io/github/package-json/v/prakashraman/notes)

Latest version **0.6.6** (published 2021-03-29) · GNU GPLv3 license · 0 weekly downloads

## Install

```sh
npm install @prakashraman/notes
pnpm add @prakashraman/notes
yarn add @prakashraman/notes
bun add @prakashraman/notes
```

Provides the command `pr-notes`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.6 |
| Published | 2021-03-29 |
| First published | 2020-10-13 |
| Weekly downloads | 0 |
| License | GNU GPLv3 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 16 |
| Unpacked size | 603.8 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Author | Prakash Raman |
| Maintainers | prakashraman |

## Links

- npm: https://www.npmjs.com/package/@prakashraman/notes
- npm.io page: https://npm.io/package/@prakashraman/notes

## Dependencies (16)

- [cpy](https://npm.io/package/cpy.md) ^8.1.1
- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [figlet](https://npm.io/package/figlet.md) ^1.5.0
- [moment](https://npm.io/package/moment.md) ^2.29.1
- [slugify](https://npm.io/package/slugify.md) ^1.4.5
- [ts-node](https://npm.io/package/ts-node.md) ^9.0.0
- [date-fns](https://npm.io/package/date-fns.md) ^2.16.1
- [inquirer](https://npm.io/package/inquirer.md) ^7.3.3
- [showdown](https://npm.io/package/showdown.md) ^1.9.1
- [commander](https://npm.io/package/commander.md) ^6.1.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.6
- [typescript](https://npm.io/package/typescript.md) ^4.0.3
- [@types/figlet](https://npm.io/package/@types/figlet.md) ^1.2.0
- [@types/inquirer](https://npm.io/package/@types/inquirer.md) ^7.3.1
- [@types/showdown](https://npm.io/package/@types/showdown.md) ^1.9.3
- [string-strip-html](https://npm.io/package/string-strip-html.md) ^6.0.4

## Recent versions

- 0.6.6 (latest) — 2021-03-29
- 0.6.5 — 2021-03-29
- 0.6.4 — 2021-03-29
- 0.6.3 — 2021-03-29
- 0.6.2 — 2021-03-28
- 0.6.1 — 2021-03-28
- 0.6.0 — 2021-03-28
- 0.5.4 — 2020-11-14
- 0.5.3 — 2020-11-04
- 0.5.2 — 2020-10-31
- 0.5.1 — 2020-10-22
- 0.5.0 — 2020-10-22
- 0.4.2 — 2020-10-22
- 0.4.1 — 2020-10-22
- 0.4.0 — 2020-10-22
- … 12 more at https://npm.io/package/@prakashraman/notes/versions

## README

# @prakashraman/notes

![Test Suite](https://github.com/prakashraman/notes/workflows/Test%20Suite/badge.svg?branch=main)
![](https://img.shields.io/github/package-json/v/prakashraman/notes)

A static personal blog generator which does not require an application server, and the notes can be written in markdown.

## Installation

```
npm i --save @prakashraman/notes
```

## How it works

There are few commands which allow complete control over the blog. Namely, `setup`, `notes:create`, `publish`

```
              _
  _ __   ___ | |_ ___  ___
 | '_ \ / _ \| __/ _ \/ __|
 | | | | (_) | ||  __/\__ \
 |_| |_|\___/ \__\___||___/

Usage: npx pr-notes command

Options:
  -h, --help      display help for command

Commands:
  setup           sets up the structure. You don't need to run this more than once
  set:title       sets the title of the homepage
  notes:create    creates a new note
  notes:list      list all the notes
  publish         publishes the notes to dist folder
  help [command]  display help for command
```

### 1. Setup the blog

```
npx pr-notes setup
```

Once run, you should see a `contents` folder in the root of your project. All your notes (markdown) files will reside in this project

**manifest.json**

This file is also created during the `setup` process and is the index of your blog. Do your best to not manually edit this file, however, if you plan to, just be careful.

### 2. Create a note

```
npx pr-notes notes:create
```

### 3. Publish the note

```
npx pr-notes publish
```

And that's it!

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