-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Post process md links in package-list files. #7425
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
deploy_website.sh
Outdated
@@ -34,6 +34,10 @@ cd $DIR | |||
:okhttp-urlconnection:dokkaGfm \ | |||
:okhttp:dokkaGfm | |||
|
|||
# mkdocs doesn't correctly handle the .md paths in package-list, so post-process. | |||
# See https://github.com/square/okhttp/issues/7338 | |||
find docs/4.x -name package-list -exec sed -i '' -e s/index.md$// -e s/\.md$/\\//g {} \; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, but I would tweak it slightly to do:
find docs/4.x -name package-list -exec sed -i '' -e 's/index.md$/index.html/' -e 's/\.md$/\.html/' -e '1 s/gfm/html/' -e '2 s/md/html/' {} \;
That keeps the index.html
and also updates the first two lines to remove references to gfm
and md
. After those changes it produces the same text as my manually updated package-list
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Fix the Dokka -> Mkdocs pipeline with md.
#fixes #7338 (comment)