Skip to content

Commit 7131cb8

Browse files
BrucegatsbybotMarcy Sutton
authored
Add remark-lint-heading-increment and resolve issues (gatsbyjs#23689)
* Add remark-lint-heading-increment and resolve issues * Make requested changes * Apply suggestions from code review Co-authored-by: gatsbybot <[email protected]> Co-authored-by: Marcy Sutton <[email protected]>
1 parent 9d7195f commit 7131cb8

File tree

7 files changed

+18
-19
lines changed

7 files changed

+18
-19
lines changed

.remarkrc.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ module.exports = {
2424
// We would like these rules to be enabled, but they require significant content changes
2525
// and need additional PRs to be implemented
2626
["remark-lint-emphasis-marker", false],
27-
["remark-lint-heading-increment", false],
2827
["remark-lint-no-heading-punctuation", false],
2928
["remark-lint-list-item-spacing", false],
3029

docs/blog/100days/gatsby-image/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,29 @@ Gatsby sites are known for their [blazing fast speed](/blog/2019-01-30-flamingo-
1717

1818
This week’s challenge invites you to add images to your blog and learn about a popular and powerful Gatsby feature, `gatsby-image`.
1919

20-
#### Part 1
20+
### Part 1
2121

2222
Add images to your markdown-based blog posts. If you are doing each challenge sequentially, then you have a [Gatsby blog that uses markdown](/blog/100days/start-blog/) for blog posts, and is [deployed live to a CDN](/blog/100days/free-hosting/).
2323

2424
But what good is a blog without beautiful images? We want you to use the resources section below to add auto-optimized images to your markdown blog posts!
2525

26-
#### Part 2
26+
### Part 2
2727

2828
Now it’s time to get direct experience using the `Img`React component provided by [`gatsby-image`](/packages/gatsby-image/)! Create an about page using JSX, then use the gatsby-image API to transform a normal selfie into a square, black-and-white image.
2929

3030
Bonus: Take note of the build times for your site before and after you add images to your project. Also, record the performance of specific pages with images, using [a tool like Lighthouse](/docs/audit-with-lighthouse/). As a Gatsby Developer you should be aware of how images affect your site’s production and user experience.
3131

32-
### Challenge Resources
32+
## Challenge Resources
3333

34-
#### Part 1 Resource
34+
### Part 1 Resource
3535

3636
Follow this tutorial that explains how to [add images to your markdown-based pages](/docs/working-with-images-in-markdown/). After you configure your site as outlined, Gatsby will auto-optimize your images for you.
3737

38-
#### Part 2 Resource
38+
### Part 2 Resource
3939

4040
[Create an About page](/docs/recipes/pages-layouts/#creating-pages-automatically) using JSX, the preferred templating language for [React](/docs/glossary/react/). After that, you can [learn about gatsby-image](/docs/working-with-images), then [use its API](/docs/gatsby-image/) to transform your selfie into a black-and-white square.
4141

42-
### How to Get Help
42+
## How to Get Help
4343

4444
Depending on your experience with Gatsby and React, this may be the hardest challenge we've given you. So, if you get stuck, please ask for help from the [Gatsby community](/contributing/community/) and the [ASKGatsbyJS](https://twitter.com/AskGatsbyJS) Twitter account. You can find fellow Gatsby Developers on [Discord](https://discordapp.com/invite/gatsby), [Reddit](https://www.reddit.com/r/gatsbyjs/), [Spectrum](https://spectrum.chat/gatsby-js), and [Dev](https://dev.to/t/gatsby).
4545

docs/blog/2018-2-7-jam-out-your-blog/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,11 +145,11 @@ With all of that said, this process has a few caveats related to working within
145145
1. If you follow a folder structure enclosing an index.md file for your posts, you will need to add the new folder within the URL of the post
146146
2. Inserting an image adds extra markup which you will need to remove for an image to show up within your post. Prose will upload the image within the same directory as your index.md file.
147147

148-
#### Default
148+
### Default
149149

150150
![Default Prose image path](before-post-title.png)
151151

152-
#### After (this will work)
152+
### After (this will work)
153153

154154
![After image path change](after-post-title.png)
155155

docs/blog/2019-04-29-component-shadowing/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ user-site
125125
Now, blue and red will have your custom values and will be reflected in the theme wherever
126126
`theme.colors.blue` and `theme.colors.red` are used.
127127

128-
#### How much shadowing is too much shadowing?
128+
### How much shadowing is too much shadowing?
129129

130130
If you've found yourself shadowing a large amount of components in a particular theme it
131131
might make sense to use a fork instead.

docs/blog/2019-11-25-introducing-gatsby-preview-for-cosmic-js/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,23 +19,23 @@ We’re excited to announce the official release of Gatsby Preview for [Cosmic](
1919
4. After onboarding, go to any Post in your Cosmic Bucket and find the big, beautiful, purple button to preview your content.
2020
![Cosmic Gatsby Preview Screenshot](./cosmic-js-gatsby-preview-screenshot.jpg)
2121

22-
#### What happens?
22+
### What happens?
2323

2424
After clicking the “Open Preview” button, a new tab will open to instantly show you what the content looks like for this specific version on your Gatsby website. This simple one-click preview will greatly enhance your content team’s content-creation workflow.
2525

2626
![Cosmic Gatsby Preview Screenshot](./cosmic-js-gatsby-preview-screenshot.gif)
2727

28-
#### How did this integration happen?
28+
### How did this integration happen?
2929

3030
The Cosmic / Gatsby Preview integration is the result of close collaboration between both teams to make the integration as easy as possible. Both sides had to refactor a bit of existing functionality to make it seamless. And the feedback that came from the collaboration effort actually helped to improve both products. We’re happy to say this powerful feature can be integrated in just a few clicks.
3131

32-
#### Why is this a big deal?
32+
### Why is this a big deal?
3333

3434
Both Gatsby and Cosmic believe deeply in providing developers the best development experience possible. But it’s not just about developers. Content creation team members are crucial to building great web products. And one of the most requested features for content creators is preview, but this has been a challenge for developer teams pushing for highly-optimized JAMStack websites built on Gatsby.
3535

3636
Gatsby Preview solves this problem by providing a simple button for content creators to experience an instant preview of content directly in the CMS dashboard. Gatsby preview with the [Cosmic headless CMS](https://www.cosmicjs.com/headless-cms), is a further extension to empower content creators to preview content quickly and easily, giving teams faster content marketing velocity.
3737

38-
#### What’s next?
38+
### What’s next?
3939

4040
We’re excited to continue to work closely with the Gatsby team to help create more value-added integrations between both services. It’s our goal to continue to provide the full spectrum of team members the best tools to be successful.
4141

docs/blog/2020-01-08-git-workflows/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,13 +293,13 @@ At this point, we have the freedom to organize our commits however we want. We c
293293

294294
No flow is without tradeoffs, and this one has a couple:
295295

296-
##### 1. It rewrites history
296+
### 1. It rewrites history
297297

298298
This flow relies heavily on rebasing, which rewrites history. This means that pushing to GitHub requires a force-push, which can be scary, especially for folks newer to using Git.
299299

300300
This also makes it harder to collaborate on a feature; you need to communicate clearly before rebasing, to make sure everyone's work is in beforehand.
301301

302-
##### 2. It involves some branch juggling
302+
### 2. It involves some branch juggling
303303

304304
With 3-4 incremental branches, developers have to bounce between them and make sure they're kept in sync. This can be tedious.
305305

docs/docs/production-app.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,15 @@ This bundle is produced from [production-app.js](https://github.com/gatsbyjs/gat
9595

9696
This contains the small [webpack-runtime](https://webpack.js.org/concepts/manifest/#runtime) as a separate bundle (configured in `optimization` section). In practice, the app and webpack-runtime are always needed together.
9797

98-
##### framework-[contenthash].js
98+
### framework-[contenthash].js
9999

100100
The framework bundle contains the React framework. Based on user behavior, React hardly gets upgraded to a newer version. Creating a separate bundle improves users' browser cache hit rate as this bundle is likely not going to be updated often.
101101

102-
##### commons-[contenthash].js
102+
### commons-[contenthash].js
103103

104104
Libraries used on every Gatsby page are bundled into the commons javascript file. By bundling these together, you can make sure your users only need to download this bundle once.
105105

106-
##### component---[name]-[contenthash].js
106+
### component---[name]-[contenthash].js
107107

108108
This is a separate bundle for each page. The mechanics for how these are split off from the main production app are covered in [Code Splitting](/docs/how-code-splitting-works/).
109109

0 commit comments

Comments
 (0)