bunki 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 KahWee Teng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,246 @@
+# Bunki
+
+[![GitHub license](https://img.shields.io/github/license/kahwee/bunki)](https://github.com/kahwee/bunki/blob/main/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/kahwee/bunki)](https://github.com/kahwee/bunki/issues)
+
+Bunki is an opinionated static site generator built with Bun. It's designed for creating blogs and simple websites with sensible defaults and minimal configuration.
+
+## Features
+
+- Markdown content with frontmatter
+- Syntax highlighting for code blocks
+- Tag-based organization
+- Year-based archives
+- Pagination for post listings
+- RSS feed generation
+- Sitemap generation
+- Local development server
+- Simple CLI interface
+
+## Installation
+
+### From npm (Coming soon)
+```bash
+# Install globally
+bun install -g bunki
+
+# Or install locally in your project
+bun install bunki
+```
+
+### From GitHub
+```bash
+# Clone the repository
+git clone git@github.com:kahwee/bunki.git
+cd bunki
+
+# Install dependencies
+bun install
+
+# Build the project
+bun run build
+
+# Link for local development
+bun link
+```
+
+## Quick Start
+
+### Initialize a New Site
+
+```bash
+# Create a new site with default templates and configuration
+bunki init
+```
+
+This will:
+- Create a default configuration file (`bunki.config.json`)
+- Set up the required directory structure
+- Create default templates
+- Add a sample blog post
+
+### Add Content
+
+Create markdown files in the `content` directory with frontmatter:
+
+```markdown
+---
+title: Your Post Title
+date: 2023-01-01T12:00:00Z
+tags: [tag1, tag2]
+---
+
+Your post content goes here...
+```
+
+Or use the CLI to create a new post:
+
+```bash
+bunki new "Your Post Title" --tags "tag1, tag2"
+```
+
+### Generate Your Site
+
+```bash
+# Generate the static site
+bunki generate
+```
+
+### Preview Your Site
+
+```bash
+# Start a local development server
+bunki serve
+```
+
+Then visit http://localhost:3000 in your browser.
+
+## Configuration
+
+The `bunki.config.json` file contains the configuration for your site:
+
+```json
+{
+  "title": "My Blog",
+  "description": "A blog built with Bunki",
+  "baseUrl": "https://example.com",
+  "domain": "blog"
+}
+```
+
+## Directory Structure
+
+```
+.
+├── bunki.config.json   # Configuration file
+├── content/            # Markdown content
+│   ├── post1.md
+│   └── post2.md
+├── templates/          # Nunjucks templates
+│   ├── base.njk
+│   ├── index.njk
+│   ├── post.njk
+│   ├── tag.njk
+│   ├── tags.njk
+│   ├── archive.njk
+│   └── styles/
+│       └── main.css
+├── public/             # Static files to copy to the site
+│   └── favicon.ico
+└── dist/               # Generated site
+    ├── index.html
+    ├── css/
+    │   └── style.css
+    └── ...
+```
+
+## Templates
+
+Bunki uses [Nunjucks](https://mozilla.github.io/nunjucks/) for templating. The templates should be placed in the `templates` directory. The default templates provide a solid starting point for most blogs.
+
+## Command Line Interface
+
+```
+Usage: bunki [options] [command]
+
+An opinionated static site generator built with Bun
+
+Options:
+  -V, --version         output the version number
+  -h, --help            display help for command
+
+Commands:
+  init [options]        Initialize a new site with default structure
+  new [options] <title> Create a new blog post
+  generate [options]    Generate static site from markdown content
+  serve [options]       Start a local development server
+  help [command]        display help for command
+```
+
+### Initialize Command
+
+```
+Usage: bunki init [options]
+
+Initialize a new site with default structure
+
+Options:
+  -c, --config <file>  Path to config file (default: "bunki.config.json")
+  -h, --help           display help for command
+```
+
+### New Post Command
+
+```
+Usage: bunki new [options] <title>
+
+Create a new blog post
+
+Arguments:
+  title                Title of the post
+
+Options:
+  -t, --tags <tags>    Comma-separated list of tags (default: "")
+  -h, --help           display help for command
+```
+
+### Generate Command
+
+```
+Usage: bunki generate [options]
+
+Generate static site from markdown content
+
+Options:
+  -c, --config <file>    Config file path (default: "bunki.config.json")
+  -c, --content <dir>    Content directory (default: "content")
+  -o, --output <dir>     Output directory (default: "dist")
+  -t, --templates <dir>  Templates directory (default: "templates")
+  -h, --help             display help for command
+```
+
+### Serve Command
+
+```
+Usage: bunki serve [options]
+
+Start a local development server
+
+Options:
+  -o, --output <dir>   Output directory (default: "dist")
+  -p, --port <number>  Port number (default: "3000")
+  -h, --help           display help for command
+```
+
+## Programmatic Usage
+
+You can also use Bunki programmatically in your own Node.js or Bun scripts:
+
+```javascript
+import { SiteGenerator, loadConfig } from 'bunki';
+import path from 'path';
+
+// Load configuration
+const config = loadConfig('bunki.config.json');
+
+// Create a generator
+const generator = new SiteGenerator({
+  contentDir: path.join(process.cwd(), 'content'),
+  outputDir: path.join(process.cwd(), 'dist'),
+  templatesDir: path.join(process.cwd(), 'templates'),
+  config
+});
+
+// Generate site
+async function generate() {
+  await generator.initialize();
+  await generator.generate();
+  console.log('Site generation complete!');
+}
+
+generate().catch(console.error);
+```
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "bunki",
+  "version": "0.1.0",
+  "description": "An opinionated static site generator built with Bun",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target node",
+    "dev": "bun run --watch src/index.ts",
+    "test": "bun test",
+    "format": "prettier --write ."
+  },
+  "bin": {
+    "bunki": "./dist/cli.js"
+  },
+  "keywords": [
+    "static-site-generator",
+    "markdown",
+    "blog",
+    "bun",
+    "typescript"
+  ],
+  "author": "KahWee Teng",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kahwee/bunki.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kahwee/bunki/issues"
+  },
+  "homepage": "https://github.com/kahwee/bunki#readme",
+  "dependencies": {
+    "commander": "^11.1.0",
+    "fs-extra": "^11.2.0",
+    "gray-matter": "^4.0.3",
+    "highlight.js": "^11.9.0",
+    "marked": "^9.1.5",
+    "marked-highlight": "^2.0.7",
+    "nunjucks": "^3.2.4",
+    "sanitize-html": "^2.11.0",
+    "slugify": "^1.6.6"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/marked": "^5.0.2",
+    "@types/node": "^20.10.0",
+    "@types/nunjucks": "^3.2.5",
+    "@types/sanitize-html": "^2.9.5",
+    "bun-types": "latest",
+    "prettier": "^3.1.0",
+    "typescript": "^5.2.2"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "engines": {
+    "bun": ">=1.0.0"
+  }
+}