improvement: improve versioning and documentation

- Add a script to generate build metadata including git hash and timestamp to provide detailed versioning information in the CLI output.
- Update the README with a comprehensive table of command-line arguments to improve documentation clarity and feature discoverability.

Author: orange-guo

.gitignore

@@ -17,3 +17,6 @@ package-lock.json
 # Environment variables
 .env
 .env.local
+
+# Generated files
+src/buildInfo.ts

README.md

@@ -41,11 +41,17 @@ Run the script from the command line and pass the appropriate arguments.
 
 ### Command-Line Arguments
 
-```bash
-docusaurus-docs-to-pdf -h
-# or
-npx docusaurus-docs-to-pdf -h
-```
+You can run `docusaurus-docs-to-pdf -h` to see the help message, or refer to the table below:
+
+| Argument | Alias | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| `--docs-url <url>` | `-u` | The base URL of the Docusaurus documentation (e.g., "http://localhost:3000/docs/introduction") | **Yes** | - |
+| `--pdf-path <path>` | `-o` | The output file path for the generated PDF (e.g., "output/my-docs.pdf") | **Yes** | - |
+| `--pdf-cover-image <pathOrUrl>` | `-c` | The URL or local file path for the PDF cover image | No | - |
+| `--pdf-margin-mm <number>` | `-m` | The margin size in millimeters to apply to all sides of the PDF pages | No | `10` |
+| `--page-concurrency <number>` | `-p` | The maximum number of concurrent browser pages to use for content fetching | No | 2x CPU cores |
+| `--css <style>` | `-S` | Inject custom CSS styles directly. Can be used multiple times | No | - |
+| `--site-rewrite <from=to>` | `-r` | Rewrite site domain in links (e.g., "http://localhost:3000=https://docs.example.com"). Can be used multiple times | No | - |
 
 ### Examples
 

package.json

@@ -19,7 +19,7 @@
     "typescript": "^5.8.3"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "node scripts/generate-build-info.js && tsc",
     "start": "node dist/main.js",
     "dev": "yarn build && yarn start"
   },

scripts/generate-build-info.js

@@ -0,0 +1,34 @@
+const fs = require('fs');
+const path = require('path');
+const { execSync } = require('child_process');
+
+try {
+    const commitHash = execSync('git rev-parse --short HEAD').toString().trim();
+    const buildTime = new Date().toISOString();
+    const packageJson = require('../package.json');
+    const version = packageJson.version;
+
+    const content = `
+export const buildInfo = {
+    version: '${version}',
+    commitHash: '${commitHash}',
+    buildTime: '${buildTime}'
+};
+`;
+
+    const outputPath = path.resolve(__dirname, '../src/buildInfo.ts');
+    fs.writeFileSync(outputPath, content);
+    console.log(`Build info generated at ${outputPath}`);
+} catch (error) {
+    console.error('Error generating build info:', error);
+    // Fallback if git is not available (e.g. inside a tarball without .git)
+    const content = `
+export const buildInfo = {
+    version: 'unknown',
+    commitHash: 'unknown',
+    buildTime: new Date().toISOString()
+};
+`;
+    const outputPath = path.resolve(__dirname, '../src/buildInfo.ts');
+    fs.writeFileSync(outputPath, content);
+}

src/main.ts

@@ -17,6 +17,7 @@ import {launchBrowser, requestForImage} from "./browser";
 import consoleStamp from "console-stamp";
 import path from "node:path";
 import * as fs from "node:fs";
+import { buildInfo } from './buildInfo';
 
 import { Command } from 'commander';
 import * as os from "node:os";
@@ -561,7 +562,7 @@ async function main() {
         console.log("[App Start] Starting PDF generation process...");
 
         program
-            .version('0.0.3')
+            .version(`${buildInfo.version} (commit: ${buildInfo.commitHash}, build: ${buildInfo.buildTime})`, '-v, --version')
             .description('Converts Docusaurus documentation to a single PDF file.')
             .option('-u, --docs-url <url>', 'The base URL of the Docusaurus documentation (e.g., "http://localhost:3000/docs/introduction")')
             .option('-o, --pdf-path <path>', 'The output file path for the generated PDF (e.g., "output/my-docs.pdf")')