btford / btford/write-good

Question: is there a way to tell write-good to ignore code blocks?

Open
#63 9 comments 3 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.1k
Forks
187
PR merge metrics
No merged PRs in 30d

Description

Hi! Tech writer here, so please excuse if there is an obvious answer that I'm just not aware of. I'm using `write-good` in a bash script to test my documentation before publishing and am getting 'failures' based on content in code blocks. I'd like to be able to tell it to skip these instead.

Example:
This code block:
```
::

user@foo# show bar
bar monitor http server-app4_10.128.10.240_8080 {
```
... causes this `write-good` result:
```
bar monitor http server-app4_10.128.10.240_8080 {
^^^
"bar" is repeated on line 220 at column 9
```

I'm also not sure if this might be an issue with `write-good`, since the word it flags as a duplicate is on a new line.

Thanks!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with write-good's command-line behavior and the duplicate-word check using the supplied Markdown code-block example. Confirm whether fenced code blocks can be excluded without changing prose checks; done means the example produces no failure for code-block content while ordinary prose is still checked.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash, javascript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.