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

Add support for "external" articles #2576

Merged
merged 5 commits into from
May 24, 2024
Merged

Add support for "external" articles #2576

merged 5 commits into from
May 24, 2024

Conversation

hadley
Copy link
Member

@hadley hadley commented May 23, 2024

Fixes #2028

@EmilHvitfeldt as well as taking a look at the code, I'd really appreciate it if you could try it out on a tidymodels website just to check that it has all the features you need.

@hadley hadley requested a review from EmilHvitfeldt May 23, 2024 19:48
Copy link

github-actions bot commented May 23, 2024

Copy link
Member

@EmilHvitfeldt EmilHvitfeldt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took it for a test drive in recipes and it worked very nice. It gave good diagnostic when used incorrectly (missing fields in external-articles items, defining items but not using them in articles

works like a charm

#'
#' pkgdown will warn if there are (non-internal) articles that aren't listed
#' in the articles index. You can suppress such warnings by listing the
#' affected articles in a section with `title: internal` (case sensitive);
#' this section will not be displayed on the index page.
#'
#' ## External articles
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this section is incomplete.

adding the external-articles: entry isn't sufficient, and should be accompanied by adding the name:s to the contents: of articles:

@hadley hadley merged commit be8bb7d into main May 24, 2024
14 checks passed
@hadley hadley deleted the external-articles branch May 24, 2024 13:38
SebKrantz pushed a commit to SebKrantz/pkgdown that referenced this pull request Jun 1, 2024
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.

Allow for external links in articles page
2 participants