https://github.com/flarebyte/scratchbook

Annotation library in Typescript for documentation
https://github.com/flarebyte/scratchbook

annotations documentation npm-package

Last synced: 15 days ago
JSON representation

Annotation library in Typescript for documentation

• Host: GitHub
• URL: https://github.com/flarebyte/scratchbook
• Owner: flarebyte
• License: mit
• Created: 2021-07-04T09:24:33.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-23T12:33:34.000Z (over 3 years ago)
• Last Synced: 2024-04-25T15:02:05.478Z (about 2 years ago)
• Topics: annotations, documentation, npm-package
• Language: TypeScript
• Homepage: https://flarebyte.github.io/scratchbook/
• Size: 256 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE-OF-CONDUCT.md

Awesome Lists containing this project

README

          
# Scratch Book

![npm](https://img.shields.io/npm/v/scratchbook)

![Build status](https://github.com/flarebyte/scratchbook/actions/workflows/main.yml/badge.svg)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/e8bc221a695648aab31dfa5853d0add7)](https://www.codacy.com/gh/flarebyte/scratchbook/dashboard?utm_source=github.com&utm_medium=referral&utm_content=flarebyte/scratchbook&utm_campaign=Badge_Grade)

![npm bundle size](https://img.shields.io/bundlephobia/min/scratchbook)

![Dependencies](https://status.david-dm.org/gh/flarebyte/scratchbook.svg)

![npm type definitions](https://img.shields.io/npm/types/scratchbook)

![node-current](https://img.shields.io/node/v/scratchbook)

![NPM](https://img.shields.io/npm/l/scratchbook)

> Scratch Book is an annotation library written in Typescript that makes it easy to write documentation in a decentralized fashion.

- **Typescript** can be used to write the documentation. Integrates perfectly with [ts-node](https://typestrong.org/ts-node/).

- **No dependency** and lightweight.

- **Advanced matchers** to query the notes.

- **Simple model** for the notes that requires very little learning curve while still offering a lot of flexibility.

- **extensive tests coverage**.

## Usage

```

const myScratchBook: ScratchBook = {

    notes: [

        createScratchNote('about/scratchbook/description', 'Annotation library'),

        createScratchNote('about/scratchbook/github', 'scratchbook on github', 'https://github.com/flarebyte/scratchbook'),

        createScratchNote('about/other/...', 'Some other projects')

    ]

}

filterScratchBook(withPrefix('about/scratchbook/'))(myScratchBook)

// will return the description and the github link

```

### Documentation

A detailed documentation for each functions is [available](https://flarebyte.github.io/scratchbook/)

### Installation

    yarn add scratchbook

## License

MIT © [2021 Flarebyte - Olivier Huin]()