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

fix(docs) Fix nested markdown in MDX components #23160

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -71,32 +71,19 @@ The second most common pain point is GraphQL. About half of our interviewees sai
Other salient feedback includes that people who have used WordPress for a long time are looking for other solutions and want Gatsby to play well with many kinds of CMSs. Finally, almost every interviewee loves the Gatsby development experience because it is smooth and fast. Here are some fun quotes:

<Pullquote citation="Alec Lomas, AZ, frontend dev and design">
You guys are pretty much nailing it. Just keep killin’ it, I guess!

You guys are pretty much nailing it. Just keep killin’ it, I guess!

</Pullquote>
<Pullquote citation="David Luhr, UT, UX">
I’ve played around with static sites in Jekyll in the past, but I’ve always
hit a pain point with how much functionality I could build into the different
includes and partials and things that were starting to become popular with
different templating languages. So I’ve always loved React for all the
encapsulation of style and functionality. And components--but I never really
knew how to use it. And Gatsby has been that first opportunity where
everything comes together, everything can be in one system. My background is
really design focused, so I think of a component library along those lines.
Until Gatsby, I never really had a way to see how I could use that across all
of our pages instead of relying on a content management library that was kind
of slow to develop in.

I’ve played around with static sites in Jekyll in the past, but I’ve always hit a pain point with how much functionality I could build into the different includes and partials and things that were starting to become popular with different templating languages. So I’ve always loved React for all the encapsulation of style and functionality. And components--but I never really knew how to use it. And Gatsby has been that first opportunity where everything comes together, everything can be in one system. My background is really design focused, so I think of a component library along those lines. Until Gatsby, I never really had a way to see how I could use that across all of our pages instead of relying on a content management library that was kind of slow to develop in.

</Pullquote>
<Pullquote citation="Juliette Pichot, Germany, web developer">
If you ever decide to sell to consumers, I really think that the speed /
responsiveness of Gatsby is a really good selling point. Like when I tried to
sell my idea of building the new site in Gatsby (which would take a little
longer compared to building it in Squarespace) to my husband, I simply showed
him how quick it is to navigate around a Gatsby site and he was instantly
sold. The explicit awareness that website speed matters a lot is currently
kinda limited to Silicon Valley etc, but the benefits are definitely apparent
as well to the average consumer. Pair that with stats around how speed
increases conversions and it'd definitely be a pretty appealing offer to
people.

If you ever decide to sell to consumers, I really think that the speed / responsiveness of Gatsby is a really good selling point. Like when I tried to sell my idea of building the new site in Gatsby (which would take a little longer compared to building it in Squarespace) to my husband, I simply showed him how quick it is to navigate around a Gatsby site and he was instantly sold. The explicit awareness that website speed matters a lot is currently kinda limited to Silicon Valley etc, but the benefits are definitely apparent as well to the average consumer. Pair that with stats around how speed increases conversions and it'd definitely be a pretty appealing offer to people.

</Pullquote>

## So what does this all mean?
Expand Down
5 changes: 3 additions & 2 deletions docs/blog/2018-07-07-graphic-design-class/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ Structure of the class:
3. _Taught them Gatsby._ Learning NextJS wasn’t as smooth as I would have liked but once we jumped to learn GatsbyJS, some interesting things happened. A light when on. They were excited.

<Pullquote>
Once we jumped to learn GatsbyJS, some interesting things happened. A light
when on. They were excited.

Once we jumped to learn GatsbyJS, some interesting things happened. A light when on. They were excited.

</Pullquote>

### What do your students like about Gatsby?
Expand Down
9 changes: 3 additions & 6 deletions docs/blog/2018-08-09-swag-store/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,9 @@ We’ve spent the last couple weeks working the kinks out, and we couldn’t be
src="./images/gatsby-swag-twitter.jpg"
/>
<figcaption>
Tweets from
[Dean](https://twitter.com/DeaNHtiD99/status/1023204484183416832),
[Elle](https://twitter.com/ARebelBelle/status/1020044426712735744),
[Chase](https://twitter.com/chaseadamsio/status/1021896138503245824), and
[Katherine](https://twitter.com/kato_katherine/status/1021967765400211456)
showing off their new Gatsby swag.

Tweets from [Dean](https://twitter.com/DeaNHtiD99/status/1023204484183416832), [Elle](https://twitter.com/ARebelBelle/status/1020044426712735744), [Chase](https://twitter.com/chaseadamsio/status/1021896138503245824), and [Katherine](https://twitter.com/kato_katherine/status/1021967765400211456) showing off their new Gatsby swag.

</figcaption>
</figure>

Expand Down
20 changes: 12 additions & 8 deletions docs/blog/2018-09-07-gatsby-values/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,9 @@ Gatsby is a distributed team, which means that on most days we only interact wit
src="./images/team-discussion.jpg"
/>
<figcaption>
The Inkteam in Portland, Oregon for a Gatsby Gathering. Photo:
<a href="https://www.houseofschaab.photography/">Danielle Schaab</a>

The Inkteam in Portland, Oregon for a Gatsby Gathering. Photo: [Danielle Schaab](https://www.houseofschaab.photography/)

</figcaption>
</figure>

Expand All @@ -54,8 +55,9 @@ While we were all together, Sam went through the themes with all of us and we wr
src="./images/kurt-sticky-note.jpg"
/>
<figcaption>
Kurt writing down really good ideas on a sticky note. Photo:
<a href="https://www.houseofschaab.photography/">Danielle Schaab</a>

Kurt writing down really good ideas on a sticky note. Photo: [Danielle Schaab](https://www.houseofschaab.photography/)

</figcaption>
</figure>

Expand All @@ -73,8 +75,9 @@ With everyone’s ideas on the board, we started grouping. [Marisa](https://twit
src="./images/values-whiteboard.jpg"
/>
<figcaption>
Kyle, Linda, and Marisa adding and grouping ideas on the whiteboard. Photo:
<a href="https://www.houseofschaab.photography/">Danielle Schaab</a>

Kyle, Linda, and Marisa adding and grouping ideas on the whiteboard. Photo: [Danielle Schaab](https://www.houseofschaab.photography/)

</figcaption>
</figure>

Expand Down Expand Up @@ -164,8 +167,9 @@ Are we acting like the company we want to be? Like the _people_ we want to be?
src="./images/team-in-the-park.jpg"
/>
<figcaption>
The Gatsby Inkteam (not pictured: Florian Kissling). Photo:{" "}
<a href="https://www.houseofschaab.photography/">Danielle Schaab</a>

The Gatsby Inkteam (not pictured: Florian Kissling). Photo:{" "} [Danielle Schaab](https://www.houseofschaab.photography/)

</figcaption>
</figure>

Expand Down
20 changes: 9 additions & 11 deletions docs/blog/2018-09-27-reach-router/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,19 @@ https://youtu.be/NKTdNv8JpuM
A primary focus (no pun intended) of @reach/router is to manage focus in client-side routing, out of the box, lifting the onus from devs to manage it from scratch. From the @reach/router documentation:

<Pullquote>
Whenever the content of a page changes in response to a user interaction, the
focus should be moved to that content; otherwise, users on assistive devices
have to search around the page to find what changed–yuck! Without the help of
a router, managing focus on route transitions requires a lot effort and
knowledge on your part.

Whenever the content of a page changes in response to a user interaction, the focus should be moved to that content; otherwise, users on assistive devices have to search around the page to find what changed–yuck! Without the help of a router, managing focus on route transitions requires a lot effort and knowledge on your part.

</Pullquote>
<Pullquote>
Reach Router provides out-of-the-box focus management so your apps are
significantly more accessible without you breaking a sweat.

Reach Router provides out-of-the-box focus management so your apps are significantly more accessible without you breaking a sweat.

</Pullquote>
<Pullquote>
When the location changes, the top-most part of your application that changed
is identified and focus is moved to it. Assistive devices then announce to the
user the group of elements they are now focused on, similarly to how it works
when they load up a page for the first time.

When the location changes, the top-most part of your application that changed is identified and focus is moved to it. Assistive devices then announce to the user the group of elements they are now focused on, similarly to how it works when they load up a page for the first time.

</Pullquote>

The video below demonstrates this focus management:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Based on these new technologies, it seems that we can move to a new serverless p
There are lots of pieces to this puzzle to still work out, but the shapes are starting to come into focus. The end result should be a streamlined process to design, build, test, and deploy new user experiences. And the resulting applications should be much faster, simpler to operate, cheaper to run, and more secure.

<Pullquote citation="Elon Musk">
Some people don’t like change, but you need to embrace change if the
alternative is disaster.

Some people don’t like change, but you need to embrace change if the alternative is disaster.

</Pullquote>
10 changes: 6 additions & 4 deletions docs/blog/2018-10-03-gatsby-perf/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ And what are some simple, meaningful metrics to _know_ if your site is blazing f
Let's get to it.

<Pullquote>
At the BBC, 10% of users are lost for every additional second the site takes
to load.

At the BBC, 10% of users are lost for every additional second the site takes to load.

</Pullquote>

## Measuring Speed
Expand Down Expand Up @@ -87,8 +88,9 @@ Gatsby v2 set out to build upon this solid foundation, while focusing on improve
It's not 🚀 science. Shipping less JavaScript to your end users makes your application faster to load, parse, and use. Think _hard_ whether that slick launch animation and heavy above the fold hero image are actually _meaningful_ to the quality experience your users want. Every additional byte of JavaScript has an associated parse and evaluation time that you're forwarding along to your end users.

<Pullquote citation="Addy Osmani">
As much as I love JavaScript, it’s always the most expensive part of your
site.

As much as I love JavaScript, it’s always the most expensive part of your site.

</Pullquote>

To that end, Gatsby v2 ships 31% less JavaScript in its client runtime. While we'd _love_ to brag about this, most of the credit goes to smart optimizations in libraries we rely upon: React--upgrading from 15 to 16--and @reach/router--swapped in place of react-router. Much like performance optimizations, build upgrades, etc. are available for free in something like [create-react-app][create-react-app], these upgrades in Gatsby v2 are available _for free_ simply by updating to Gatsby v2 by following the [migration guide][migration-guide]. The power of opinionated, optimized toolsets that internalize smart defaults!
Expand Down
6 changes: 5 additions & 1 deletion docs/blog/2018-10-10-unbundling-of-the-cms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,11 @@ Enterprises who have purchased these CMS solutions are left asking themselves on
height="400"
src="./headless-cms-landscape.png"
/>
<figcaption>The [headless CMS](/docs/headless-cms/) landscape</figcaption>
<figcaption>

The [headless CMS](/docs/headless-cms/) landscape

</figcaption>
</figure>

## Making integration feasible via a content mesh
Expand Down
6 changes: 3 additions & 3 deletions docs/blog/2018-10-11-rise-of-modern-web-development/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ And the evidence? Increasingly, award-winning websites such as the leading "corp
<figure>
<img alt="" src="./bmw-arch-digest-spotify.png" />
<figcaption>
<a href="https://bmw.com">bmw.com</a> -- Angular //{" "}
<a href="https://architecturaldigest.com">AD (Conde Nast)</a> -- React //{" "}
<a href="https://spotify.me">Spotify.me</a> -- Vue

[bmw.com](https://bmw.com) -- Angular // [AD (Conde Nast)](https://architecturaldigest.com) -- React // [Spotify.me](https://spotify.me) -- Vue

</figcaption>
</figure>

Expand Down
10 changes: 6 additions & 4 deletions docs/blog/2018-10-16-why-mobile-performance-is-crucial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ Why is that? Increased site complexity often distributes bottlenecks across mult
As Gatsby's co-founder Kyle Mathews likes to say (paraphrasing Tolstoy):

<Pullquote>
All fast websites are alike, but all slow websites are slow in different ways.

All fast websites are alike, but all slow websites are slow in different ways.

</Pullquote>

Ultimately, we’ll argue, performance must be solved _at the framework level_ -- that is, in the content mesh.
Expand Down Expand Up @@ -112,9 +114,9 @@ For example, if you use a CDN to serve 3MB JavaScript bundles, your site is stil
<figure>
<img alt="" src="./network-requests-adobe-com.png" />
<figcaption>
Part of a network request waterfall chart for a typical enterprise website (
<a href="https://www.adobe.com">adobe.com</a>). The full waterfall chart is
three times longer.

Part of a network request waterfall chart for a typical enterprise website [adobe.com](https://adobe.com). The full waterfall chart is three times longer.

</figcaption>
</figure>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,9 @@ The answer: choose a content mesh. A content mesh:
height="300"
/>
<figcaption>
The Content Mesh integrates <b>headless</b> content systems, modern
development tools, and website performance

The Content Mesh integrates **headless** content systems, modern development tools, and website performance

</figcaption>
</figure>

Expand Down
5 changes: 3 additions & 2 deletions docs/blog/2018-10-25-using-gatsby-without-graphql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ Most examples in the Gatsby docs and on the web at large focus on leveraging sou
<figure>
<img alt="" height="400" src="./integration_layer.png" />
<figcaption>
Gatsby's GraphQL integration layer is the glue between presentation layer
and where your data lives

Gatsby's GraphQL integration layer is the glue between presentation layer and where your data lives

</figcaption>
</figure>

Expand Down
6 changes: 3 additions & 3 deletions docs/blog/2018-11-16-youfit-case-study/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ Prior to the website rebuild, Youfit viewed their website as an “add-on” bec
Zach and the Youfit team were happy with the results, amazed by the fast page load times, and would use Gatsby again for future projects.

<Pullquote citation="Zach Muha">
We are very happy with the results so far, especially the 60% increase in
leads. The website went from a burden to a strategic tool we use to capture
leads and generate ROI.

We are very happy with the results so far, especially the 60% increase in leads. The website went from a burden to a strategic tool we use to capture leads and generate ROI.

</Pullquote>

By using Gatsby, Youfit significantly increased their organic traffic, lead capture and ROI. Youfit also laid the foundation for long-term success by improving their Google ranking and making their site mobile friendly. This enabled Youfit to focus on what it does best: making proactive wellness more accessible to all.
Expand Down
13 changes: 6 additions & 7 deletions docs/blog/2018-12-04-gatsby-analogy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,9 @@ Similarly, you could spend 10,000 hours becoming a kung fu master in performance
In [Gatsby for apps](/blog/2018-11-07-gatsby-for-apps/), we recently explained:

<Pullquote citation="Dustin Schau">
Gatsby is great for building web experiences that leverage the benefits of
both so-called static sites and web applications — simultaneously. You don’t
have to sacrifice the advantages of one approach to reap the benefits of the
other.

Gatsby is great for building web experiences that leverage the benefits of both so-called static sites and web applications — simultaneously. You don’t have to sacrifice the advantages of one approach to reap the benefits of the other.

</Pullquote>

When you visit a Gatsby site, a static, server-rendered HTML page is loaded first, and then it hydrates into a React app.
Expand Down Expand Up @@ -82,9 +81,9 @@ Say you order delivery for dinner. It arrives, you eat. Later, you look at the m
With Gatsby, your data can be sourced from just about anywhere -- content management systems, Markdown, APIs, databases, etc. A recent series on the Gatsby blog detailed the concept of the “[content mesh](/blog/2018-10-04-journey-to-the-content-mesh/)”:

<Pullquote>
[Gatsby is] the infrastructure layer for a decoupled website. The content mesh
stitches together content systems in a modern development environment while
optimizing website delivery for performance.

[Gatsby is] the infrastructure layer for a decoupled website. The content mesh stitches together content systems in a modern development environment while optimizing website delivery for performance.

</Pullquote>

With Gatsby, you can source your data into a consolidated data layer, which you can query against directly. No matter where your data comes from, you can access it all from a single query. Get data from wherever it lives to the right place in your website in the right form exactly when it's needed.
Expand Down
18 changes: 9 additions & 9 deletions docs/blog/2018-12-17-ibm-case-study/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ Alison Joseph, Frontend Developer at IBM, took over this project from a coworker
Alison was the only developer able to focus full-time on the Gatsby project and it took about six months before the new site launched in October 2018. She’s quick to point out if they had gone the custom, in-house route, the project would have easily taken twice as long and required more than one developer.

<Pullquote>
Gatsby just works. With the old system, I had to fight with something for a
few days to troubleshoot issues. With Gatsby, you install and it just works.
It’s stress-free.

Gatsby just works. With the old system, I had to fight with something for a few days to troubleshoot issues. With Gatsby, you install and it just works. It’s stress-free.

</Pullquote>

With non-technical content writers and designers needing the ability to add content quickly to the site, the “second to none onboarding” made it easy for everyone, regardless of skill level, to be successful. The Gatsby documentation made it easy to onboard new developers and the process was simple enough for any of the content creators to understand. This achieved one of the most important goals for the website: the documentation and process was there for the next person so they wouldn’t struggle.

<Pullquote>
A home-grown system goes down when the people who created it leave. Gatsby
doesn’t allow for that - it grows with whoever is at the controls then
seamlessly passes on to the next person.

A home-grown system goes down when the people who created it leave. Gatsby doesn’t allow for that - it grows with whoever is at the controls then seamlessly passes on to the next person.

</Pullquote>

## A New Era
Expand All @@ -52,9 +52,9 @@ The new Carbon Design System website launched October 3, 2018, and is referenced
<figcaption>Lighthouse Performance Scores with Gatsby</figcaption>
</figure>
<Pullquote>
We’re copying Gatsby as a best practice. Whenever we’re working out how to
engage our community, we look to Gatsby as the shining example and ask
ourselves, What does Gatsby do?

We’re copying Gatsby as a best practice. Whenever we’re working out how to engage our community, we look to Gatsby as the shining example and ask ourselves, What does Gatsby do?

</Pullquote>

## Final Thoughts
Expand Down
Loading