doclific 0.2.1 → 0.2.2

package/LICENSE

@@ -0,0 +1,17 @@
+Business Source License 1.1
+
+Licensor: Luke Mueller
+Licensed Work: Doclific
+Additional Use Grant:
+You may use this software internally, including in commercial environments.
+
+Restrictions:
+You may not:
+- Redistribute, sell, sublicense, or white-label the software
+- Offer the software as a hosted or managed service
+- Distribute modified versions of the software
+
+Change Date: 2029-01-01
+Change License: Apache License, Version 2.0
+
+This license does not grant trademark rights.

package/dist/bin/doclific.js

@@ -1,11 +1,39 @@
 #!/usr/bin/env node
 import { spawn } from 'child_process';
 import { startServer } from '../server/index.js';
-const port = process.argv.find((arg) => arg.startsWith('-p=') || arg.startsWith('--port='))?.split('=')[1] ||
-    6767;
-const cwd = process.cwd();
-console.log('Doclific CLI running in directory:', cwd);
-startServer(Number(port));
-// Optional: open browser automatically
-const open = process.platform === 'win32' ? 'start' : process.platform === 'darwin' ? 'open' : 'xdg-open';
-spawn(open, [`http://localhost:${port}`]);
+import { mkdir } from 'fs/promises';
+import { existsSync } from 'fs';
+import path from 'path';
+const command = process.argv[2];
+if (command === 'init') {
+    const cwd = process.cwd();
+    const doclificDir = path.join(cwd, 'doclific');
+    if (existsSync(doclificDir)) {
+        console.log('Directory "doclific" already exists.');
+        process.exit(0);
+    }
+    mkdir(doclificDir, { recursive: true })
+        .then(() => {
+        console.log(`Created directory: ${doclificDir}`);
+        process.exit(0);
+    })
+        .catch((error) => {
+        console.error('Failed to create directory:', error);
+        process.exit(1);
+    });
+}
+else {
+    const port = process.argv
+        .find((arg) => arg.startsWith('-p=') || arg.startsWith('--port='))
+        ?.split('=')[1] || 6767;
+    const cwd = process.cwd();
+    console.log('Doclific CLI running in directory:', cwd);
+    startServer(Number(port));
+    // Optional: open browser automatically
+    const open = process.platform === 'win32'
+        ? 'start'
+        : process.platform === 'darwin'
+            ? 'open'
+            : 'xdg-open';
+    spawn(open, [`http://localhost:${port}`]);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "doclific",
-	"version": "0.2.1",
+	"version": "0.2.2",
 	"type": "module",
 	"bin": {
 		"doclific": "./dist/bin/doclific.js"
@@ -8,9 +8,16 @@
 	"scripts": {
 		"build": "tsc",
 		"format": "prettier --write \"src/**/*.{ts,tsx,js,jsx,json}\"",
-		"format:check": "prettier --check \"src/**/*.{ts,tsx,js,jsx,json}\"",
-		"postinstall": "npm i && npm run build && cd frontend && npm install && npm run build"
+		"format:check": "prettier --check \"src/**/*.{ts,tsx,js,jsx,json}\""
 	},
+	"license": "BUSL-1.1",
+	"files": [
+		"README.md",
+		"LICENSE",
+		"dist",
+		"package.json",
+		"frontend/dist"
+	],
 	"dependencies": {
 		"@mdx-js/mdx": "^3.1.1",
 		"@orpc/client": "^1.12.2",

package/readme.md

@@ -0,0 +1,77 @@
+# Doclific
+
+A powerful documentation tool for creating and managing documentation with a modern web interface.
+
+## Installation
+
+Install Doclific globally using npm:
+
+```bash
+npm install -g doclific
+```
+
+## Getting Started
+
+### 1. Initialize a Project
+
+Navigate to the root directory of your project and run:
+
+```bash
+doclific init
+```
+
+This creates a `doclific` directory in your current working directory where your documentation will be stored.
+
+### 2. Start the Server
+
+From the root directory of your project, run:
+
+```bash
+doclific
+```
+
+This starts the Doclific web server on port `6767` by default. The server will automatically open in your browser.
+
+### Custom Port
+
+You can specify a custom port using the `-p` or `--port` flag:
+
+```bash
+doclific -p=8080
+# or
+doclific --port=8080
+```
+
+## Commands
+
+- `doclific init` - Creates a `doclific` directory in the current working directory
+- `doclific` - Starts the Doclific web server (default port: 6767)
+- `doclific -p=<port>` - Starts the server on a custom port
+- `doclific --port=<port>` - Alternative syntax for custom port
+
+## Usage
+
+After initializing and starting the server:
+
+1. Access the documentation interface at `http://localhost:6767` (or your custom port)
+2. Create and organize your documentation files in the `doclific` directory
+3. Use the sidebar to navigate between documents
+4. Edit documents using the built-in editor with syntax highlighting and code snippets
+
+## Features
+
+- 📝 Rich markdown editor with live preview
+- 🎨 Syntax highlighting for code blocks
+- 📁 File tree navigation
+- 🔍 Codebase snippet integration
+- 🎯 Slash commands for quick formatting
+- 📱 Responsive design
+
+## Requirements
+
+- Node.js (v18 or higher recommended)
+- npm
+
+## License
+
+See [LICENSE](LICENSE) file for details.

package/.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

package/.prettierignore

@@ -1,5 +0,0 @@
-node_modules
-dist
-*.log
-package-lock.json
-

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "semi": true,
-  "trailingComma": "es5",
-  "singleQuote": true,
-  "printWidth": 100,
-  "tabWidth": 4,
-  "useTabs": true,
-  "arrowParens": "always"
-}

package/.vscode/settings.json

@@ -1,13 +0,0 @@
-{
-  "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "[typescript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[javascript]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  },
-  "[json]": {
-    "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
-}

package/frontend/components.json

@@ -1,24 +0,0 @@
-{
-  "$schema": "https://ui.shadcn.com/schema.json",
-  "style": "new-york",
-  "rsc": false,
-  "tsx": true,
-  "tailwind": {
-    "config": "",
-    "css": "src/index.css",
-    "baseColor": "zinc",
-    "cssVariables": true,
-    "prefix": ""
-  },
-  "iconLibrary": "lucide",
-  "aliases": {
-    "components": "@/components",
-    "utils": "@/lib/utils",
-    "ui": "@/components/ui",
-    "lib": "@/lib",
-    "hooks": "@/hooks"
-  },
-  "registries": {
-    "@plate": "https://platejs.org/r/{name}.json"
-  }
-}

package/frontend/eslint.config.js

@@ -1,23 +0,0 @@
-import js from '@eslint/js'
-import globals from 'globals'
-import reactHooks from 'eslint-plugin-react-hooks'
-import reactRefresh from 'eslint-plugin-react-refresh'
-import tseslint from 'typescript-eslint'
-import { defineConfig, globalIgnores } from 'eslint/config'
-
-export default defineConfig([
-  globalIgnores(['dist']),
-  {
-    files: ['**/*.{ts,tsx}'],
-    extends: [
-      js.configs.recommended,
-      tseslint.configs.recommended,
-      reactHooks.configs.flat.recommended,
-      reactRefresh.configs.vite,
-    ],
-    languageOptions: {
-      ecmaVersion: 2020,
-      globals: globals.browser,
-    },
-  },
-])

package/frontend/index.html

@@ -1,25 +0,0 @@
-<!doctype html>
-<html lang="en">
-	<head>
-		<meta charset="UTF-8" />
-		<link rel="icon" type="image/svg+xml" href="/vite.svg" />
-		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
-		<title>Doclific</title>
-		<link rel="preconnect" href="https://fonts.googleapis.com" />
-		<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
-		<link
-			href="https://fonts.googleapis.com/css2?family=Google+Sans+Code:ital,wght@0,300..800;1,300..800&display=swap"
-			rel="stylesheet"
-		/>
-		<script>
-			const BACKEND_PORT = 6767;
-			window.env = {
-				PORT: BACKEND_PORT,
-			};
-		</script>
-	</head>
-	<body>
-		<div id="root"></div>
-		<script type="module" src="/src/main.tsx"></script>
-	</body>
-</html>