-
Notifications
You must be signed in to change notification settings - Fork 10.3k
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
Implement file name emphasis in docs #8393
Labels
type: documentation
An issue or pull request for improving or updating Gatsby's documentation
Comments
shannonbux
added
the
type: documentation
An issue or pull request for improving or updating Gatsby's documentation
label
Sep 20, 2018
@shannonbux 🎉 I'll see if I can find some time to get the copy snippet stuff working. Could be kinda fun to work on! |
shannonbux
pushed a commit
that referenced
this issue
Oct 1, 2018
I saw #8393 and implemented the changes in the tutorial. In this first pass I simply added the file names to the code blocks and didn't change the text before/after the code block (except Part 3 & 4). Feel free to change the text before the code blocks @shannonbux. I didn't want to overlook you here.
DSchau
pushed a commit
that referenced
this issue
Oct 26, 2018
jedrichards
pushed a commit
to jedrichards/gatsby
that referenced
this issue
Nov 1, 2018
gpetrioli
pushed a commit
to gpetrioli/gatsby
that referenced
this issue
Jan 22, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
type: documentation
An issue or pull request for improving or updating Gatsby's documentation
Summary
At the top of code snippets, the file name where they ought to be pasted should be emphasized.
Basic example
Here is the PR that implemented the functionality: #7867
Now we just need to go through the docs and the tutorial (and possibly official plugin and starter READmes?) and use the functionality wherever there is a code snippet that is meant to be pasted into a specific file.
Motivation
In a workshop last May, I noticed that many people paste code snippets into the incorrect file. This way of emphasizing file names will hopefully help everyone paste code into the correct place.
Next steps
If anyone wants to also tackle #5030, that would be an ideal companion issue to tackle along with this one.
The text was updated successfully, but these errors were encountered: