Skip to content

GEMINI.md

Latest commit

 

History

History
42 lines (36 loc) · 2.14 KB

GEMINI.md

File metadata and controls

42 lines (36 loc) · 2.14 KB

MD2DOC-Evolution - Gemini Development Context

Project Overview

A Markdown to Word (DOCX) conversion tool specifically designed for technical book authors. It bridges the gap between Markdown writing and professional publishing requirements.

Tech Stack

  • Frontend: React 19, TypeScript, Vite 6.
  • Styling: CSS-in-JS/Theming (constants/theme.ts), Bootstrap CSS mentioned in mandates but currently using a custom modular architecture with centralized theming.
  • Core Libraries: docx (Word generation), marked (Markdown parsing), mermaid (Chart rendering).
  • Testing: Vitest, React Testing Library.

Key Architectures

  • Registry Pattern: Used for Docx generation (services/docx/registry.ts). Handlers for different block types are registered in services/docx/builders/index.ts.
  • AST Parsing: Markdown is parsed into tokens using marked and then processed into ParsedBlock objects in services/parser/ast.ts.

Branching & Workflow (Per CONTRIBUTING.md)

  • main: Production (Squash Merge from dev).
  • dev: Integration branch.
  • Feature Branch: dev_feature_yyyyMMdd_XXXX (branched from dev).
  • Version Bumping:
    • Minor for new features.
    • Patch for bug fixes.
  • Version Bump Checklist (MUST Update All):
    1. package.json: version field.
    2. README.md: Title line & Version Badge.
    3. README_EN.md: Title line & Version Badge.
    4. CHANGELOG.md: Add new section.
    5. constants/defaultContent.ts: Update example version numbers in code blocks.

Coding Standards

  • Follow existing patterns in services/docx/builders/.
  • Use TypeScript for all new code.
  • Ensure new features have corresponding tests in tests/.

Shared Context

  • The project uses a custom Regex + AST approach for parsing.
  • Always check services/types.ts for data structures.
  • Word document styling is defined in constants/theme.ts and services/docx/builders/common.ts.
  • Documentation:
    • docs/PROJECT_OVERVIEW.md: High-level feature summary.
    • docs/ARCHITECTURE.md: Technical architecture and workflows.
    • docs/DEVELOPMENT_GUIDE.md: Setup and dev workflow.