scratchbook v0.4.1

Scratch Book

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.
• 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

Installation

yarn add scratchbook

License

MIT © 2021 Flarebyte - Olivier Huin