Configuration tips: Make links more accessible
Standardize "/' usage in bathelp definitions
Updated Configuration tips (markdown)
Updated Configuration tips (markdown)
Updated Configuration tips (markdown)
Updated Configuration tips (markdown)
Updated Configuration tips (markdown)
Update links to 'Bat theme support' after the rename
Configuration tips: misc changes
Configuration tips: cover some tips stripped from the Readme
Updated Configuration tips (markdown)
Updated Configuration tips (markdown)
Updated Configuration tips (markdown)
Rename section to "bathelp alias (basic configuration)"
Original name was kinda confusing, the "basic" part is like a subtitle,
not some kind of shell alias type.
I considered whether the internal links I use after this change
("#bathelp-alias-basic-configuration", without parens) would be
incompatible with the HTML generated by other MD compilers. [1] It _may
be_ down the line (e.g.: if someone uses Pandoc to generate the Wiki
docs).
I tried adding the anchor tag the chat suggested as "workaround
for consistency" but then markdownlint complains because it doesn't like
raw HTML and because it won't recognize links to a raw anchor tag, only
those that target headings.
This seems fixable if we use [2] but it seems too much hassle when we're
just targeting the GitHub Wiki compiler and it doesn't seem like we'll
use any other parsers for the foreseeable future.
So I'm going no-compat mode with this.
[2] https://github.com/edemaine/markdownlint-rule-github-internal-links
[1] Considerations (DeepSeek):
1. **GitHub Flavored Markdown (GFM)**
- GitHub's Markdown parser removes parentheses from anchor links. For example:
- Heading: `# bathelp alias (basic configuration)`
- Anchor: `#bathelp-alias-basic-configuration`
- Parentheses are **not** included.
---
2. **GitLab Flavored Markdown**
- Similar to GitHub, GitLab's Markdown parser also removes parentheses from anchor links.
- Heading: `# bathelp alias (basic configuration)`
- Anchor: `#bathelp-alias-basic-configuration`
- Parentheses are **not** included.
---
3. **Visual Studio Code (VS Code) Markdown Preview**
- VS Code's built-in Markdown preview removes parentheses from anchor links.
- Heading: `# bathelp alias (basic configuration)`
- Anchor: `#bathelp-alias-basic-configuration`
- Parentheses are **not** included.
---
4. **Markdown parsers that retain parentheses**
Some parsers or tools may retain parentheses in anchor links. These include:
- **Pandoc**
- Pandoc, a popular Markdown processor, retains parentheses in anchor links by default.
- Heading: `# bathelp alias (basic configuration)`
- Anchor: `#bathelp-alias-(basic-configuration)`
- Parentheses are **included**.
- **CommonMark (some implementations)**
- While CommonMark itself does not specify how to handle parentheses, some implementations may retain them.
- Check the specific CommonMark parser you're using to confirm.
- **Hugo (with Goldmark)**
- Hugo's default Markdown renderer, Goldmark, may retain parentheses in anchor links depending on the configuration.
- Heading: `# bathelp alias (basic configuration)`
- Anchor: `#bathelp-alias-(basic-configuration)`
- Parentheses are **included**.
- **Jekyll (with Kramdown)**
- Jekyll's Kramdown parser may retain parentheses in anchor links.
- Heading: `# bathelp alias (basic configuration)`
- Anchor: `#bathelp-alias-(basic-configuration)`
- Parentheses are **included**.
---
Workaround for Consistency
If you need consistent behavior across different parsers, you can manually define the anchor link using HTML:
```markdown
<a id="bathelp-alias-(basic-configuration)"></a>
```
Then link to it like this:
```markdown
[Link to bathelp alias](#bathelp-alias-(basic-configuration))
```
This ensures the anchor link works regardless of the parser's behavior.
Rewrite <SOME_CMD> to <CMD> in examples
I was editing the Readme's Configuration section and I find this flows
more naturally. And it's still easy to understand that it should be
replaced.
Updated Configuration tips (markdown)
Updated Configuration tips (markdown)
Rename basic configuration section to bathelp
Updated Configuration tips (markdown)
Add Configuration tips v1, Theme support v0