-
Notifications
You must be signed in to change notification settings - Fork 127
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
Docs: Add @PageColor to the customization guide #691
Conversation
@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. |
You can also use a ``PageColor`` metadata directive to set the fill color for an | ||
intro section of a specific article: |
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.
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.
Sources/docc/DocCDocumentation.docc/customizing-the-appearance-of-your-documentation-pages.md
Outdated
Show resolved
Hide resolved
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** |
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.
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.
@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. |
c2d29bf
to
51c1dd9
Compare
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. |
@natikgadzhi @d-ronnqvist Are there further changes planned here or shall we merge? |
I think we can merge this. We can always to further changes in later PRs. |
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.
Thank you @natikgadzhi!
@swift-ci please test |
@ethan-kusters @d-ronnqvist thank you for returning to this! |
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.