Fix documentation for list parameters with correct URL and rendering

[Copilot]

Q	A
Bug fix?	yes
New feature?	no
New tutorial?	no
Related issues?	reverts issues from #108, addresses original confusion about --skip-domains

What's in this Pull Request?

PR #104 was reverted due to incorrect URL format and markdown rendering issues. This PR reintroduces the documentation improvements with corrections.

Key Changes:

• Fixed ReadTheDocs URL: Changed advanced.html → advanced/ in README.md
• Added "Working with List Parameters" section: Explains comma-separated format for --skip-domains, --skip-files, --extensions, etc.
• Fixed code block rendering: Moved examples outside list items so they render as syntax-highlighted code instead of plain text
• Added usage examples: Single and multiple value examples for all list parameters
• Updated .gitignore: Excludes comment.md and docs/site/

Correct usage:

# Single value
markdown-checker -d . -f check_broken_urls --skip-domains=example.com

# Multiple values (comma-separated, no spaces)
markdown-checker -d . -f check_broken_urls --skip-domains=example.com,test.com

Common mistakes documented:

• ❌ --skip-domains=[example.com,test.com] (square brackets not allowed)
• ❌ --skip-domains=example.com, test.com (spaces break parsing)
• ✅ --skip-domains=example.com,test.com

Documentation Preview:

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• test.com
  • Triggering command: /usr/bin/python3 /home/REDACTED/.local/bin/markdown-checker -d /tmp/test_md -f check_broken_urls --skip-domains=example.com --timeout=5 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>--skip-domains not acceping a list</issue_title>
<issue_description>Describe the bug
The --skip-domains argument is not accepting a list, for me. It works fine with a single URL in the list, but adding a second one causes it to fail.

To Reproduce
Steps to reproduce the behavior:

1. Add two URLs to the list after --skip-domains=.
2. Run markdown-checker.
3. See failure:

Usage: markdown-checker [OPTIONS] SRC ...
Try 'markdown-checker --help' for help.

Error: Invalid value for 'SRC ...': Path 'https://url-here.com]' does not exist.

Expected behavior
I expect that it should accept a list of multiple URLs. I may be wrong about this behavior.

Desktop (please complete the following information):

• OS: macOS
• Browser Waterfox
• Version macOS 15.6.1

Additional context
I can call --skip-domains twice to get both URLs skipped, so there is currently a workaround.
</issue_description>

<agent_instructions>@copilot
create a new pull request with corrected things

This is the correct url for advanced page, the url you used was wrong
https://markdown-checker.readthedocs.io/en/latest/advanced/

and the markdown blocks you added with code example in the advanced page did not render correctly in the published website, also the list didn't render correctly review the current documentation and follow the same formatting

here is the old pull request for reference
#104</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@john0isaac Thank you for reporting will release a fix soon. @john0isaac I thought so as I couldn't find a way to replicate the issue. I will update the documentation thanks for following up.

• Fixes --skip-domains not acceping a list #102

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.