hongdown 0.1.0-dev.7 → 0.1.0-dev.8

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
@@ -134,6 +147,8 @@ indent_width = 4          # Indentation for nested items
 [ordered_list]
 odd_level_marker = "."    # "1." at odd nesting levels
 even_level_marker = ")"   # "1)" at even nesting levels
+pad = "start"             # "start" or "end" for number alignment
+indent_width = 4          # Indentation for nested items
 
 [code_block]
 fence_char = "~"          # "~" or "`"
@@ -251,60 +266,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.8+4f6b2b27",
   "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.8+4f6b2b27",
+    "@hongdown/darwin-x64": "0.1.0-dev.8+4f6b2b27",
+    "@hongdown/linux-arm64": "0.1.0-dev.8+4f6b2b27",
+    "@hongdown/linux-x64": "0.1.0-dev.8+4f6b2b27",
+    "@hongdown/win32-arm64": "0.1.0-dev.8+4f6b2b27",
+    "@hongdown/win32-x64": "0.1.0-dev.8+4f6b2b27"
   }
 }