hongdown 0.2.0-dev.75 → 0.2.0-dev.78

package/README.md

@@ -99,10 +99,14 @@ hongdown - < input.md
 hongdown --line-width 100 input.md
 ~~~~
 
-### Disable directives
+### HTML comment directives
 
-Hongdown supports special HTML comments to disable formatting for specific
-sections of your document:
+Hongdown supports special HTML comment directives to control formatting
+behavior within documents.
+
+#### Disable formatting
+
+You can disable formatting for specific sections:
 
 ~~~~ markdown
 <!-- hongdown-disable-file -->
@@ -134,6 +138,27 @@ This section is not formatted.
 This section is formatted again.
 ~~~~
 
+#### Sentence case customization
+
+When sentence case is enabled, you can define document-specific proper nouns
+and common nouns:
+
+~~~~ markdown
+<!-- hongdown-proper-nouns: Swift, Go -->
+<!-- hongdown-common-nouns: Python -->
+
+# Using Swift And Go For Python Development
+
+This heading will be formatted as: "Using Swift and Go for python development"
+~~~~
+
+ -  `<!-- hongdown-proper-nouns: Word1, Word2 -->` – Defines proper nouns to
+    preserve (case-sensitive)
+ -  `<!-- hongdown-common-nouns: Word1, Word2 -->` – Overrides built-in proper
+    nouns by treating them as common nouns
+
+These directives are merged with configuration file settings.
+
 ### Configuration file
 
 Hongdown looks for a *.hongdown.toml* file in the current directory and
@@ -154,6 +179,9 @@ line_width = 80           # Maximum line width (default: 80)
 [heading]
 setext_h1 = true          # Use === underline for h1 (default: true)
 setext_h2 = true          # Use --- underline for h2 (default: true)
+sentence_case = false     # Convert headings to sentence case (default: false)
+proper_nouns = []         # Additional proper nouns to preserve (default: [])
+common_nouns = []         # Exclude built-in proper nouns (default: [])
 
 [list]
 unordered_marker = "-"    # "-", "*", or "+" (default: "-")
@@ -217,6 +245,7 @@ Hongdown enforces the following conventions:
 
  -  Level 1 and 2 use Setext-style (underlined with `=` or `-`)
  -  Level 3+ use ATX-style (`###`, `####`, etc.)
+ -  Optional sentence case conversion (disabled by default)
 
 ~~~~ markdown
 Document Title
@@ -228,6 +257,53 @@ Section
 ### Subsection
 ~~~~
 
+#### Sentence case (optional)
+
+When `sentence_case = true` is set in the configuration, Hongdown automatically
+converts headings to sentence case using intelligent heuristics:
+
+~~~~ markdown
+# Development Commands      → Development commands
+# Working With JSON APIs    → Working with JSON APIs
+# Using `MyClass` In Code   → Using `MyClass` in code
+~~~~
+
+The converter:
+
+ -  Capitalizes only the first word
+ -  Preserves code spans (text in backticks)
+ -  Preserves acronyms (2+ consecutive uppercase letters, e.g., `API`, `HTTP`)
+ -  Preserves proper nouns (built-in list + user-configured)
+ -  Handles hyphenated words (e.g., `JSON-RPC`)
+ -  Respects quoted text capitalization
+ -  Preserves non-Latin scripts (CJK, etc.)
+
+You can add custom proper nouns to preserve:
+
+~~~~ toml
+[heading]
+sentence_case = true
+proper_nouns = ["MyCompany", "MyProduct", "MyAPI"]
+~~~~
+
+You can also exclude built-in proper nouns by treating them as common nouns.
+This is useful for words like “Go” which can be either a programming language
+or a common verb:
+
+~~~~ toml
+[heading]
+sentence_case = true
+common_nouns = ["Go", "Swift"]  # Treat these as common nouns, not proper nouns
+~~~~
+
+Built-in proper nouns include ~450 entries: programming languages (JavaScript,
+TypeScript, Python, Rust, Go), technologies (GitHub, Docker, React, Node.js),
+databases (PostgreSQL, MySQL, MongoDB), countries (United States, Republic of
+Korea), natural languages (English, Korean, Japanese), and more.
+
+You can also use HTML comment directives to define document-specific proper
+nouns and common nouns.  See the “HTML comment directives” section for details.
+
 ### Lists
 
  -  Unordered lists use ` -  ` (space-hyphen-two spaces)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hongdown",
-    "version": "0.2.0-dev.75+6d4f84bb",
+    "version": "0.2.0-dev.78+569a02cd",
     "type": "module",
     "description": "A Markdown formatter that enforces Hong Minhee's Markdown style conventions",
     "license": "GPL-3.0-or-later",
@@ -27,11 +27,11 @@
         "node": "\u003e=18"
     },
     "optionalDependencies": {
-        "@hongdown/darwin-arm64": "0.2.0-dev.75+6d4f84bb",
-        "@hongdown/darwin-x64": "0.2.0-dev.75+6d4f84bb",
-        "@hongdown/linux-arm64": "0.2.0-dev.75+6d4f84bb",
-        "@hongdown/linux-x64": "0.2.0-dev.75+6d4f84bb",
-        "@hongdown/win32-arm64": "0.2.0-dev.75+6d4f84bb",
-        "@hongdown/win32-x64": "0.2.0-dev.75+6d4f84bb"
+        "@hongdown/darwin-arm64": "0.2.0-dev.78+569a02cd",
+        "@hongdown/darwin-x64": "0.2.0-dev.78+569a02cd",
+        "@hongdown/linux-arm64": "0.2.0-dev.78+569a02cd",
+        "@hongdown/linux-x64": "0.2.0-dev.78+569a02cd",
+        "@hongdown/win32-arm64": "0.2.0-dev.78+569a02cd",
+        "@hongdown/win32-x64": "0.2.0-dev.78+569a02cd"
     }
 }