https://github.com/cbush/docdoctor

rST/docutils/sphinx/snooty doctor
https://github.com/cbush/docdoctor

Last synced: 4 months ago
JSON representation

rST/docutils/sphinx/snooty doctor

• Host: GitHub
• URL: https://github.com/cbush/docdoctor
• Owner: cbush
• License: mit
• Created: 2022-06-02T01:39:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-13T14:44:22.000Z (6 months ago)
• Last Synced: 2024-10-03T12:42:22.192Z (4 months ago)
• Language: TypeScript
• Size: 1.49 MB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Docdoctor

A tool for hacking rST

## Build & Run

Clone the repo, then:

```sh

cd docdoctor

npm install

npm run build

node ./build/main --help

```

## Commands (Incomplete List)

### Readability

The `getReadabilityText` command takes file paths as arguments, delimited

by spaces. Pass in a snooty.toml with the flag `--snootyTomlPath`.

This command parses traverses nodes in each file to convert the rst to plain

text. It outputs the plain text for each file as a new file in an `output`

directory, using the same name and directory structure as the input path.

For example, an rST file at `test/delete-a-realm.txt` outputs as plain text

to `output/test/delete-a-realm.txt`.

In addition to converting the rST to plain text, this command removes

markup and things that would skew readability scores, such as code examples.

It also adds punctuation to titles and makes other small tweaks to things

that would otherwise falsely impact the readability score of the page text.

Usage Example:

```shell

node ./build/main getReadabilityText test/readability/delete-a-realm.txt --snootyTomlPath=test/readability/snooty.toml

```