DoctorDoc

AsciiDoc and Markdown Utility Tool.

How to run

$ npm i -g doctordoc
$ doctordoc

Default Flags

Running doctordoc without any flags is the same as running it with the --all flag and it contains the following checks:

| Flag | Description | Run Mode | |------------------------------------------|-----------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| | --all | Run all checks. | Default if no other flag is set. Doesn't run --browse, --view-github-markdown command. | | --adoc-validate-links | Validate that AsciiDoc links exist on the file system. | | | --adoc-validate-dates | Validate that dates exist within the calendar year. | | | --md-validate-links | Validate that Markdown file links exist on the file system. | |

Doctordoc searches for file extensions ending with .adoc and .md in the current directory and subdirectories.

It ignores the following folders: node_modules, .venv, and .terraform.

It ignores the following files: combined_course_markdown.md.

Additional Flags

When one of these flags is set, the default flags are not run.

| Flag | Description | |--------------------------------------------------|---------------------------------------------------------------------------------------------------| | --browse [path] | Open repository URL for file/directory. Defaults to the current directory if no path is provided. | | --preview-github-markdown <file_path> | Send a markdown file to the GitHub API and see the generated HTML file in your browser. | | --generate-asciidoc-links <file_or_folder_path>| Generate AsciiDoc links for a .md file or directory with .md files. |

Taught on

In .adoc files is it possible to create a line like this **Taught on**: <weekday> to validate dates if dates are present in a table.

This works by validating that the date exists within the current calendar year. Dates can be defined like Feb 2nd, February 2nd or with slight variations thereof.

It is possible to have to hide the Taught on line in a comment. It will still validate the dates.

It's possible to have multiple weekdays separated by commas.

Design Decisions

This is mainly a CLI to aid with validation in Git repositories. --md-validate-links includes checks for links that are valid in the browser.