Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix "Error reading page 'index.md': extendMarkdown()" #87

Merged
merged 3 commits into from
Aug 3, 2022
Merged

Conversation

iamEAP
Copy link
Member

@iamEAP iamEAP commented Aug 3, 2022

What / Why

Saw reports in discord of folks who merely run pip install mkdocs-techdocs-core==1.* in their set up, then run mkdocs build, get the following error:

ERROR    -  Error reading page 'index.md': extendMarkdown() missing 1 required positional argument: 'md_globals'
mkdocs failed, exit code: 1

This PR:

  • Adds a simple end-to-end test (run mkdocs build after freshly installing this plugin) to catch run-time errors like this.
  • Tightens the Markdown version constraint to only those versions that are compatible with the current version of mkdocs.

Follow-up to #74.

See also: mkdocs/mkdocs#2892

@iamEAP iamEAP requested a review from a team as a code owner August 3, 2022 09:10
@iamEAP iamEAP force-pushed the test/e2e branch 3 times, most recently from 12aa7a1 to 6451917 Compare August 3, 2022 09:25
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
@iamEAP iamEAP changed the title Add a simple end-to-end test Fix "Error reading page 'index.md': extendMarkdown()" Aug 3, 2022
Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
@iamEAP iamEAP merged commit ad649c5 into main Aug 3, 2022
@iamEAP iamEAP deleted the test/e2e branch August 3, 2022 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants