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

Docs: Add @PageColor to the customization guide #691

Merged
merged 3 commits into from
Sep 29, 2023

Conversation

natikgadzhi
Copy link
Contributor

Bug/issue #, if applicable: Closes #537

Summary

Adds a snippet on using @PageColor to doc:customizing-the-appearance-of-your-documentation-pages to follow up on #525!

Dependencies

No dependencies, this PR only has documentation changes.

@natikgadzhi
Copy link
Contributor Author

@ethan-kusters I was looking around the list of issues for something else, and stumbled on this — thought I'd clean this up while I have a minute.

Comment on lines 87 to 88
You can also use a ``PageColor`` metadata directive to set the fill color for an
intro section of a specific article:
Copy link
Contributor

Choose a reason for hiding this comment

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

The PageColor directive doesn't specifically set the fill color. It is an accent color that isn't associated to any specific on-page element. See the PageColor documentation overview.

colors are used for foreground colors, like text. Note that colors defined in
`theme-settings.json` will be used across all pages of your documentation bundle.

**Changing a color on for a specific article page**
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be a sub-sub heading that briefly describe the per-page customization? That could be a good place to talk about both PageColor and PageImage together.

@natikgadzhi
Copy link
Contributor Author

@d-ronnqvist That's one half-assed pull request, and I apologize. I will experiment with it myself and clean this up in a little bit. Took a pause to write an RFC about #515.

@natikgadzhi
Copy link
Contributor Author

This one is minor, but I think ready for review. Next thing I'm curious about are Snippets, but I'll work with them a bit more to be more comfortable writing docs about them.

@franklinsch
Copy link
Member

@natikgadzhi @d-ronnqvist Are there further changes planned here or shall we merge?

@d-ronnqvist
Copy link
Contributor

I think we can merge this. We can always to further changes in later PRs.

Copy link
Contributor

@ethan-kusters ethan-kusters left a comment

Choose a reason for hiding this comment

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

Thank you @natikgadzhi!

@ethan-kusters
Copy link
Contributor

@swift-ci please test

@ethan-kusters ethan-kusters merged commit ff057d2 into apple:main Sep 29, 2023
2 checks passed
@natikgadzhi
Copy link
Contributor Author

@ethan-kusters @d-ronnqvist thank you for returning to this!

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.

Update "Customizing the appearance of your documentation pages" documentation for @PageColor
4 participants