Upgrade mkdocs and fix relative links in markdown #2783
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is partly because if we upgrade enough mkdocs-related things it'll make some dependency security warnings go away The changes here are mostly because mkdocs 1.5 does more aggressive checking for bad links and we previously had links in markdown that didn't work I'm not sure if/how those links worked in the html docs, but I guess I can get that after marking a PR
dweitzman-codaio
changed the title
| @@ -76,7 +76,7 @@ function compileExamples() { | |||
| throw new Error(`${exampleFooterLink} is not a valid path`); | |||
| } | |||
| exampleFooterLink = `${SdkReferenceLink}${exampleFooterLink}`; | |||
| learnMoreLink = example.linkData.url; | |||
| learnMoreLink = example.linkData.url! + (example.linkData.url?.endsWith('/') ? 'index.md' : '.md'); | |||
There was a problem hiding this comment.
This is hacky, but I'm using a trailing slash to indicate links should go to /index.md vs no trailing slash to mean /foo means /foo.md
| @@ -12,7 +12,7 @@ | |||
| "url": "/guides/blocks/column-formats" | |||
| }, | |||
| "exampleFooterLink": "https://coda.io/packs/build/latest/guides/blocks/column-formats", | |||
| "learnMoreLink": "/guides/blocks/column-formats", | |||
| "learnMoreLink": "/guides/blocks/column-formats.md", | |||
There was a problem hiding this comment.
I don't think it will work to have the .md links in this file, since it's used to power the Help side panel in the Pack Studio.
Instead of changing documentation_compiler.ts to add the extension, instead add it in documentation/example_page_template.md which only affects the generated markdown used by mkdocs.
1 task
|
This pull request has been inactive for 7 days: labeled as stale. To avoid auto-closure in 7 days, please do one of the following: Add |
dweitzman-codaio
added
keep-active
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is partly because if we upgrade enough mkdocs-related things it'll make some dependency-related security warnings go away
The changes here are mostly because mkdocs 1.5 does more aggressive checking for bad links and we previously had links in markdown that didn't work
It seems like the links are still working in the HTML docs as well