hongdown 0.3.0-dev.115 → 0.3.0-dev.128

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +37 -3
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -161,9 +161,43 @@ These directives are merged with configuration file settings.
161
161
 
162
162
  ### Configuration file
163
163
 
164
- Hongdown looks for a *.hongdown.toml* file in the current directory and
165
- parent directories. You can also specify a configuration file explicitly
166
- with the `--config` option.
164
+ Hongdown supports cascading configuration files from multiple locations.
165
+ Configuration files are loaded and merged in the following order (lowest to
166
+ highest priority):
167
+
168
+ 1. **System-wide**: */etc/hongdown/config.toml* (Linux/Unix only)
169
+ 2. **User (legacy)**: *~/.hongdown.toml* (all platforms)
170
+ 3. **User (platform-specific)**:
171
+ - Linux: *$XDG\_CONFIG\_HOME/hongdown/config.toml* or
172
+ *~/.config/hongdown/config.toml*
173
+ - macOS: *~/Library/Application Support/hongdown/config.toml*
174
+ - Windows: *%APPDATA%\\hongdown\\config.toml*
175
+ 4. **Project**: *.hongdown.toml* in the current directory or any parent
176
+ directory
177
+
178
+ Settings from higher-priority configurations override those from lower-priority
179
+ ones. This allows you to set global defaults at the user or system level while
180
+ overriding them for specific projects.
181
+
182
+ You can also specify a configuration file explicitly with the `--config` option,
183
+ which bypasses the cascading system and uses only that file.
184
+
185
+ #### Disabling configuration inheritance
186
+
187
+ To ignore all system and user configurations and use only your project config:
188
+
189
+ ~~~~ toml
190
+ no_inherit = true
191
+
192
+ # Your project-specific settings
193
+ line_width = 100
194
+ ~~~~
195
+
196
+ When `no_inherit = true`, only the project config and Hongdown's defaults are
197
+ used. This is useful for projects that need strict formatting control
198
+ regardless of user preferences.
199
+
200
+ #### Configuration options
167
201
 
168
202
  Below is an example configuration with all available options and their
169
203
  default values:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hongdown",
3
- "version": "0.3.0-dev.115+649febd1",
3
+ "version": "0.3.0-dev.128+d1c74014",
4
4
  "type": "module",
5
5
  "description": "A Markdown formatter that enforces Hong Minhee's Markdown style conventions",
6
6
  "license": "GPL-3.0-or-later",
@@ -27,11 +27,11 @@
27
27
  "node": "\u003e=18"
28
28
  },
29
29
  "optionalDependencies": {
30
- "@hongdown/darwin-arm64": "0.3.0-dev.115+649febd1",
31
- "@hongdown/darwin-x64": "0.3.0-dev.115+649febd1",
32
- "@hongdown/linux-arm64": "0.3.0-dev.115+649febd1",
33
- "@hongdown/linux-x64": "0.3.0-dev.115+649febd1",
34
- "@hongdown/win32-arm64": "0.3.0-dev.115+649febd1",
35
- "@hongdown/win32-x64": "0.3.0-dev.115+649febd1"
30
+ "@hongdown/darwin-arm64": "0.3.0-dev.128+d1c74014",
31
+ "@hongdown/darwin-x64": "0.3.0-dev.128+d1c74014",
32
+ "@hongdown/linux-arm64": "0.3.0-dev.128+d1c74014",
33
+ "@hongdown/linux-x64": "0.3.0-dev.128+d1c74014",
34
+ "@hongdown/win32-arm64": "0.3.0-dev.128+d1c74014",
35
+ "@hongdown/win32-x64": "0.3.0-dev.128+d1c74014"
36
36
  }
37
37
  }