docs: add API reference for params passed to gatsby-node APIs #12087
Conversation
This file contains hidden or 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
pieh
commented
Feb 25, 2019
pieh
commented
Feb 25, 2019
|
Page looks great! Excited to get this out there. |
m-allanson
suggested changes
Feb 26, 2019
jlengstorf
reviewed
Feb 27, 2019
wardpeet
reviewed
Feb 28, 2019
| import { Header } from "./utils" | ||
| import { options, scale } from "../../utils/typography" | ||
|
|
||
| const Optional = styled.span` |
There was a problem hiding this comment.
unsure if screen readers read the content field. ping @marcysutton
There was a problem hiding this comment.
That's good point. It probably makes sense to adjust. I'm just not sure what semantic structure actually makes sense to use here.
There was a problem hiding this comment.
Yes they do read it! It becomes part of the computed text for an element node.
|
Is this basically ready to go? @pieh do you want to handle the final TODO list you mentioned in the description and get this merged in? I think there's huge value in in getting these docs live on .org, then we can follow up with any smaller changes as needed. |
marcysutton
reviewed
Mar 9, 2019
Co-Authored-By: pieh <[email protected]>
Co-Authored-By: pieh <[email protected]>
Co-Authored-By: pieh <[email protected]>
Co-Authored-By: pieh <[email protected]>
Co-Authored-By: pieh <[email protected]>
Co-Authored-By: pieh <[email protected]>
Co-Authored-By: pieh <[email protected]>
Co-Authored-By: pieh <[email protected]>
this needs further documentatoin changes to explain `internal.content` and lazy loading alternative of exporting `loadNodeContent` from plugins (like gatsby-source-filesystem)
Co-Authored-By: pieh <[email protected]>
sidharthachatterjee
pushed a commit
that referenced
this pull request
Mar 20, 2019
* feat(www): Spring cleaning episode 5
Attention, noooooooooob Friday stuff … potential public humiliation stuff 😅🥳
Since we want to define `presets.space` in relation to Typography.js’ `rhythm`, but doing so directly in `presets` would have introduced a circular dependency among `utils/presets` and `utils/typography` (from what _I_ think I understand 🤓), up to now we had to put values from `presets.space` through `rhythm` for each usage in components:
```
import { space } from "../../utils/presets"
import { rhythm } from "../../utils/typography"
padding: ${rhythm(space[7])} ${rhythm(space[4])} ${rhythm(space[4])};
```
This caused a lot of unnecessary noise, and was an ugly derivation from the norm for that one group of design tokens in `presets` … and of course smells a lot.
This PR cleans that up — as good as I can.
I would appreciate any input and I’m happy to adjust this, crossing fingers that this PR at least shows where I want things to go:
```
import { space } from "../../utils/presets"
padding: ${space[7]} ${space[4]} ${space[4]};
```
- minimize direct usage of Typography.js’ `scale` and `rhythm`
- maximize usage of `presets` tokens for consistency, and make that easy and as concise as possible
—
- split up design tokens in `utils/presets` and move them to `utils/tokens/*` — theme-style FTW?!
- move `utils/colors` to `utils/tokens/colors`
- refactor to remove circular dependency among `utils/typography` and `utils.presets` — this enables us to use Typography.js’ `rhythm` in `utils.presets` so we can avoid manual „composition“ of `scale` values in components
- move `paddingLeft` helper function used in `components/sidebar/accordion` and `components/sidebar/section-title` to `utils/sidebar/indention`
* Tidy stuff from #12087
* Tidy
* D’oh
* Use `presets.fonts` in components
… instead of `typography.options` and `join(`,`)
Move font stack definitions to tokens.
* Drop uppercase and tracking for main nav items
Lowercase is (subjectively) more legible and friendly, takes less space, matches the mobile navigation items, and magically resolves space issues on screens below „lg“
* Fix refactoring fails
* Drop WebKit scrollbars for starters, showcase
* Drop WebKit scrollbar styles for docs/tutorials, plugins sidebars
* Realign docs/tutorial, plugins sidebars
- move padding to anchor/title — allow
- calmer „Expand/Collapse All“ button
- increase sidebar „utility“ height (containing the „Expand/Collapse All“ button) height/whitespace
- move a couple sidebar variables to `utils/sidebars/presets`, enables configuration of a couple of things:
- sidebar item hover background color
- sidebar item borders — I decided to drop those for now, can be brought back via changing a color variable
- minimum item height
- active „section item“ background
- sidebar background color for offscreen/small screens, and persistent/larger screens
- adjust `colors.ui`
- drop `colors.ui.border`
- freshen up `light`, `bright`, and `whisper`
- bump default sidebar width
- simplify „stepsUI“ (used for anchor links in „Tutorial“) — remove dashed lines
- reduce sidebar active item font weight — dial it back to 600, which should be supported by the majority of the system font stack
- improved distinction among top-level sections (via border-bottom and vertical whitespace)
- sidebar expand/collapse chevron button now covers 100% of the item's height
* Fix padding-right for subitems with caret
* Move `level` info to `item-list`, hide level 0 expanded accordion border bottom if there’s only one accordion
* Remove unused
* Fix apostrophes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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 includes changes from #11597 which is needed for nested and also some really unrelated changes (to make preview work on netlify). Actual changes for review are limited to pieh/gatsby@58c6855...pieh:www-doc-preview
.org preview available at https://www-doc-preview--tender-curie-facda8.netlify.com/docs/node-api-helpers/
TO-DO before the merge:
/docs/node-api-helpers(from/docs/node-apis-helpers)Closes #4120