hongdown 0.1.0-dev.7 → 0.1.0-dev.9

package/README.md

@@ -1,32 +1,45 @@
 Hongdown
 ========
 
-Hongdown is a Markdown formatter that enforces Hong Minhee's Markdown style
-conventions.  The formatter is implemented in Rust using the [comrak] library
-for parsing.  It produces consistently formatted Markdown output following
-a distinctive style used across multiple projects including [Fedify], [Hollo],
-and [Vertana].
-
-The name *Hongdown* is a portmanteau of *Hong* (from Hong Minhee, the author)
-and *Markdown*.  It also sounds like the Korean word *hongdapda* (홍답다),
-meaning "befitting of Hong" or "Hong-like."
+[![crates.io][crates.io badge]][crates.io]
+[![npm][npm badge]][npm]
+[![GitHub Actions][GitHub Actions badge]][GitHub Actions]
 
-[comrak]: https://docs.rs/comrak
-[Fedify]: https://github.com/dahlia/fedify
-[Hollo]: https://github.com/dahlia/hollo
-[Vertana]: https://github.com/dahlia/vertana
+Hongdown is a Markdown formatter that enforces [Hong Minhee's Markdown style]
+conventions.  The formatter is implemented in Rust using the [Comrak] library
+for parsing.  It produces consistently formatted Markdown output following
+a distinctive style used across multiple projects including [Fedify], [LogTape],
+and [Optique].
+
+[crates.io badge]: https://img.shields.io/crates/v/hongdown?logo=rust
+[crates.io]: https://crates.io/crates/hongdown
+[npm badge]: https://img.shields.io/npm/v/hongdown?logo=npm
+[npm]: https://www.npmjs.com/package/hongdown
+[GitHub Actions badge]: https://github.com/dahlia/hongdown/actions/workflows/main.yaml/badge.svg
+[GitHub Actions]: https://github.com/dahlia/hongdown/actions/workflows/main.yaml
+[Hong Minhee's Markdown style]: ./AGENTS.md#markdown-style-guide
+[Comrak]: https://comrak.ee/
+[Fedify]: https://fedify.dev/
+[LogTape]: https://logtape.org/
+[Optique]: https://optique.dev/
 
 
 Installation
 ------------
 
-### npm (Node.js)
+### npm
 
 ~~~~ bash
 npm install -g hongdown
 ~~~~
 
-### Cargo (Rust)
+### mise
+
+~~~~ bash
+mise use github:dahlia/hongdown
+~~~~
+
+### Cargo
 
 ~~~~ bash
 cargo install hongdown
@@ -113,32 +126,37 @@ Hongdown looks for a `.hongdown.toml` file in the current directory and
 parent directories.  You can also specify a configuration file explicitly
 with the `--config` option.
 
+Below is an example configuration with all available options and their
+default values:
+
 ~~~~ toml
 # File patterns (glob syntax)
-include = ["*.md", "docs/**/*.md"]  # Files to format
-exclude = ["node_modules/**"]        # Files to skip
+include = []              # Files to format (default: none, specify on CLI)
+exclude = []              # Files to skip (default: none)
 
 # Formatting options
-line_width = 80
+line_width = 80           # Maximum line width (default: 80)
 
 [heading]
-setext_h1 = true          # Use === underline for h1
-setext_h2 = true          # Use --- underline for h2
+setext_h1 = true          # Use === underline for h1 (default: true)
+setext_h2 = true          # Use --- underline for h2 (default: true)
 
 [list]
-unordered_marker = "-"    # "-", "*", or "+"
-leading_spaces = 1        # Spaces before marker
-trailing_spaces = 2       # Spaces after marker
-indent_width = 4          # Indentation for nested items
+unordered_marker = "-"    # "-", "*", or "+" (default: "-")
+leading_spaces = 1        # Spaces before marker (default: 1)
+trailing_spaces = 2       # Spaces after marker (default: 2)
+indent_width = 4          # Indentation for nested items (default: 4)
 
 [ordered_list]
-odd_level_marker = "."    # "1." at odd nesting levels
-even_level_marker = ")"   # "1)" at even nesting levels
+odd_level_marker = "."    # "." or ")" at odd nesting levels (default: ".")
+even_level_marker = ")"   # "." or ")" at even nesting levels (default: ")")
+pad = "start"             # "start" or "end" for number alignment (default: "start")
+indent_width = 4          # Indentation for nested items (default: 4)
 
 [code_block]
-fence_char = "~"          # "~" or "`"
-min_fence_length = 4      # Minimum fence length
-space_after_fence = true  # Space between fence and language
+fence_char = "~"          # "~" or "`" (default: "~")
+min_fence_length = 4      # Minimum fence length (default: 4)
+space_after_fence = true  # Space between fence and language (default: true)
 ~~~~
 
 When `include` patterns are configured, you can run Hongdown without
@@ -192,7 +210,7 @@ Section
 ~~~~ markdown
  -  First item
  -  Second item
-    -  Nested item
+     -  Nested item
 ~~~~
 
 ### Code blocks
@@ -231,9 +249,9 @@ See the [documentation] for more details.
  -  Pipes are aligned accounting for East Asian wide characters
  -  Minimum column width is maintained
 
-See [SPEC.md] for the complete style specification.
+See the [*Markdown style guide*] for more detailed style conventions.
 
-[SPEC.md]: SPEC.md
+[*Markdown style guide*]: ./AGENTS.md#markdown-style-guide
 
 
 Library usage
@@ -251,60 +269,18 @@ println!("{}", output);
 ~~~~
 
 
-TODO
-----
-
-### Phase 1: Core formatting
-
- -  [x] Basic CLI with file input/output
- -  [x] Front matter preservation (YAML/TOML)
- -  [x] Headings (setext and ATX)
- -  [x] Paragraphs with line wrapping
- -  [x] Lists (ordered and unordered)
- -  [x] Code blocks (fenced)
- -  [x] Block quotes
- -  [x] Inline formatting (emphasis, strong, code, links)
- -  [x] Basic test suite
-
-### Phase 2: Extended syntax
-
- -  [x] Tables with alignment
- -  [x] Definition lists
- -  [x] GitHub alerts/admonitions
- -  [x] Footnotes
- -  [x] Reference link collection and placement
-
-### Phase 3: Polish
-
- -  [x] Configuration file support
-    -  [x] Config file parsing and discovery (`.hongdown.toml`)
-    -  [x] `line_width` option
-    -  [x] `[heading]` section
-        -  [x] `setext_h1` option
-        -  [x] `setext_h2` option
-    -  [x] `[list]` section
-        -  [x] `unordered_marker` option
-        -  [x] `leading_spaces` option
-        -  [x] `trailing_spaces` option
-        -  [x] `indent_width` option
-    -  [x] `[ordered_list]` section
-        -  [x] `odd_level_marker` option
-        -  [x] `even_level_marker` option
-    -  [x] `[code_block]` section
-        -  [x] `fence_char` option
-        -  [x] `min_fence_length` option
-        -  [x] `space_after_fence` option
- -  [x] Check mode for CI integration
- -  [x] Diff output mode
- -  [x] Disable directives
- -  [x] Edge case handling
- -  [ ] Performance optimization
+Etymology
+---------
+
+The name *Hongdown* is a portmanteau of *Hong* (from Hong Minhee, the author)
+and *Markdown*.  It also sounds like the Korean word *hongdapda* (홍답다),
+meaning “befitting of Hong” or “Hong-like.”
 
 
 License
 -------
 
-Distributed under the [GPL-3.0-or-later].  See [LICENSE] for more information.
+Distributed under the [GPL-3.0-or-later].  See *[LICENSE]* for more information.
 
 [GPL-3.0-or-later]: https://www.gnu.org/licenses/gpl-3.0.html
-[LICENSE]: LICENSE
+[LICENSE]: ./LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hongdown",
-  "version": "0.1.0-dev.7+6178b8ad",
+  "version": "0.1.0-dev.9+629cb07a",
   "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": ">=18"
   },
   "optionalDependencies": {
-    "@hongdown/darwin-arm64": "0.1.0-dev.7+6178b8ad",
-    "@hongdown/darwin-x64": "0.1.0-dev.7+6178b8ad",
-    "@hongdown/linux-arm64": "0.1.0-dev.7+6178b8ad",
-    "@hongdown/linux-x64": "0.1.0-dev.7+6178b8ad",
-    "@hongdown/win32-arm64": "0.1.0-dev.7+6178b8ad",
-    "@hongdown/win32-x64": "0.1.0-dev.7+6178b8ad"
+    "@hongdown/darwin-arm64": "0.1.0-dev.9+629cb07a",
+    "@hongdown/darwin-x64": "0.1.0-dev.9+629cb07a",
+    "@hongdown/linux-arm64": "0.1.0-dev.9+629cb07a",
+    "@hongdown/linux-x64": "0.1.0-dev.9+629cb07a",
+    "@hongdown/win32-arm64": "0.1.0-dev.9+629cb07a",
+    "@hongdown/win32-x64": "0.1.0-dev.9+629cb07a"
   }
 }