binyamin / nekuda

A set of varied tools for creating your own static-site workflow.

Nekuda

A set of varied tools for creating your own static-site workflow.

About

The name

In Hebrew, the word nekuda (נקודה) can be translated as "a point". This project is like the dot in the letter "i", or the period at the end of a sentence. It's just a bag of puzzle pieces.

Usage

Not on NPM just yet. Install via the GitHub URL.

<npm install | yarn add> https://github.com/binyamin/nekuda

Provides

• Engine (class) - extends nunjucks.Environment (source)
  • Adds a "renderToFile" convenience method.
• Server (class) - static file server (source)
• Utils.fs - various filesystem functions (source)

💬 Open for comments

I'd love to hear your thoughts. If you're comfortable, share with me your initial impression via GitHub discussions or email (see my profile).

Note: I'm not just blowing steam when I ask for your opinion. Discussion is part of why I love open-source.

🗺️ Roadmap

• Look over JSDoc comments
• Test the code somehow
• Make index.js a viable tool (see comments in file)
• Generate typedefs

Legal

Any source-code is provided under the terms of the MIT license. Copyright 2021 Binyamin Aron Green.