Index

B

BaseCheck (class in markdown_checker.checks.base)

BrokenPathsCheck (class in markdown_checker.checks.broken_paths) BrokenURLsCheck (class in markdown_checker.checks.broken_urls)

C

check() (markdown_checker.MarkdownURL method) (markdown_checker.models.url.MarkdownURL method) CheckResult (class in markdown_checker.checker)

Config (class in markdown_checker) current_dir (markdown_checker.reports.base.GeneratorBase attribute) (markdown_checker.reports.markdown.MarkdownGenerator attribute)

D

detect_issues() (in module markdown_checker.checker)

E

exists() (markdown_checker.MarkdownPath method) (markdown_checker.models.path.MarkdownPath method)

F

fallback_retry_delay (markdown_checker.Config attribute) file_path (markdown_checker.MarkdownLinkBase attribute) (markdown_checker.models.base.MarkdownLinkBase attribute)

format_issues_table() (in module markdown_checker.reports.format_output) format_links() (in module markdown_checker.reports.format_output)

G

generate() (markdown_checker.reports.base.GeneratorBase method) (markdown_checker.reports.markdown.MarkdownGenerator method) GeneratorBase (class in markdown_checker.reports.base) get_files_paths_list() (in module markdown_checker.utils.list_files)

get_full_path() (markdown_checker.MarkdownPath method) (markdown_checker.models.path.MarkdownPath method) get_full_path_relative() (markdown_checker.MarkdownPath method) (markdown_checker.models.path.MarkdownPath method) get_links_from_md_file() (in module markdown_checker.utils.extract_links)

H

has_locale() (markdown_checker.MarkdownLinkBase method) (markdown_checker.models.base.MarkdownLinkBase method) has_tracking() (markdown_checker.MarkdownLinkBase method) (markdown_checker.models.base.MarkdownLinkBase method)

host_name() (markdown_checker.MarkdownURL method) (markdown_checker.models.url.MarkdownURL method) http_status_code (markdown_checker.models.url.URLCheckResult attribute)

I

init_spin() (markdown_checker.utils.spinner.Spinner method) issue (markdown_checker.MarkdownLinkBase attribute) (markdown_checker.models.base.MarkdownLinkBase attribute)

issue_level (markdown_checker.MarkdownLinkBase attribute) (markdown_checker.models.base.MarkdownLinkBase attribute) issues (markdown_checker.checker.CheckResult attribute)

L

line_number (markdown_checker.MarkdownLinkBase attribute) (markdown_checker.models.base.MarkdownLinkBase attribute) link (markdown_checker.MarkdownLinkBase attribute) (markdown_checker.models.base.MarkdownLinkBase attribute) link_type (markdown_checker.checks.base.BaseCheck attribute) (markdown_checker.checks.broken_paths.BrokenPathsCheck attribute) (markdown_checker.checks.broken_urls.BrokenURLsCheck attribute) (markdown_checker.checks.locale.URLsLocaleCheck attribute) (markdown_checker.checks.tracking.PathsTrackingCheck attribute) (markdown_checker.checks.tracking.URLsTrackingCheck attribute)

links_checked (markdown_checker.checker.CheckResult attribute) ListOfStrings (class in markdown_checker.cli)

M

markdown_checker module markdown_checker.checker module markdown_checker.checks.base module markdown_checker.checks.broken_paths module markdown_checker.checks.broken_urls module markdown_checker.checks.locale module markdown_checker.checks.tracking module markdown_checker.cli module markdown_checker.models.base module markdown_checker.models.path module markdown_checker.models.url module markdown_checker.reports.base module markdown_checker.reports.format_output module markdown_checker.reports.markdown module markdown_checker.utils.extract_links module

markdown_checker.utils.list_files module markdown_checker.utils.spinner module MarkdownGenerator (class in markdown_checker.reports.markdown) MarkdownLinkBase (class in markdown_checker) (class in markdown_checker.models.base) MarkdownLinks (class in markdown_checker.utils.extract_links) MarkdownPath (class in markdown_checker) (class in markdown_checker.models.path) MarkdownURL (class in markdown_checker) (class in markdown_checker.models.url) module markdown_checker markdown_checker.checker markdown_checker.checks.base markdown_checker.checks.broken_paths markdown_checker.checks.broken_urls markdown_checker.checks.locale markdown_checker.checks.tracking markdown_checker.cli markdown_checker.models.base markdown_checker.models.path markdown_checker.models.url markdown_checker.reports.base markdown_checker.reports.format_output markdown_checker.reports.markdown markdown_checker.utils.extract_links markdown_checker.utils.list_files markdown_checker.utils.spinner

N

name (markdown_checker.checks.base.BaseCheck attribute) (markdown_checker.checks.broken_paths.BrokenPathsCheck attribute) (markdown_checker.checks.broken_urls.BrokenURLsCheck attribute) (markdown_checker.checks.locale.URLsLocaleCheck attribute) (markdown_checker.checks.tracking.PathsTrackingCheck attribute) (markdown_checker.checks.tracking.URLsTrackingCheck attribute)

O

output_mode (markdown_checker.Config attribute)

P

parsed_url (markdown_checker.MarkdownURL property) (markdown_checker.models.url.MarkdownURL property) path_without_fragments (markdown_checker.MarkdownPath property) (markdown_checker.models.path.MarkdownPath property)

paths (markdown_checker.utils.extract_links.MarkdownLinks attribute) PathsTrackingCheck (class in markdown_checker.checks.tracking)

R

remove_fragments() (markdown_checker.MarkdownPath method) (markdown_checker.models.path.MarkdownPath method) retries (markdown_checker.Config attribute) retry_after (markdown_checker.models.url.URLCheckResult attribute) retry_on_429 (markdown_checker.Config attribute) run() (markdown_checker.checks.base.BaseCheck method) (markdown_checker.checks.broken_paths.BrokenPathsCheck method) (markdown_checker.checks.broken_urls.BrokenURLsCheck method) (markdown_checker.checks.locale.URLsLocaleCheck method) (markdown_checker.checks.tracking.PathsTrackingCheck method) (markdown_checker.checks.tracking.URLsTrackingCheck method)

run_check_on_files() (in module markdown_checker.checker)

S

skip_domains (markdown_checker.Config attribute) skip_urls_containing (markdown_checker.Config attribute) Spinner (class in markdown_checker.utils.spinner) spinner() (in module markdown_checker.utils.spinner)

spinner_cycle (markdown_checker.utils.spinner.Spinner attribute) start() (markdown_checker.utils.spinner.Spinner method) status (markdown_checker.models.url.URLCheckResult attribute) stop() (markdown_checker.utils.spinner.Spinner method)

T

templates (markdown_checker.reports.base.GeneratorBase attribute) timeout (markdown_checker.Config attribute)

tracking_domains (markdown_checker.Config attribute) type_cast_value() (markdown_checker.cli.ListOfStrings method)

U

URLCheckResult (class in markdown_checker.models.url) urls (markdown_checker.utils.extract_links.MarkdownLinks attribute)

URLsLocaleCheck (class in markdown_checker.checks.locale) URLsTrackingCheck (class in markdown_checker.checks.tracking)