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

feat(blog): Using Themes for Distributed Docs #15330

Merged
merged 3 commits into from
Jul 3, 2019
Merged

feat(blog): Using Themes for Distributed Docs #15330

merged 3 commits into from
Jul 3, 2019

Conversation

trevorblades
Copy link
Contributor

This post discusses Apollo's experience using Themes to build our documentation websites, and examines some of our favourite parts of developing websites with Themes.

@trevorblades trevorblades requested a review from a team July 2, 2019 21:37
@trevorblades trevorblades changed the title feat(blog): Making Docs Awesome with Themes feat(blog): Using Themes for Distributed Docs Jul 2, 2019
Copy link
Contributor

@marcysutton marcysutton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so exciting! I left a few suggestions to make sure the docs references are up to date. What a great post! Thanks for contributing.


Gatsby’s preeminent Markdown parser, `gatsby-transformer-remark` features a rich ecosystem of useful plugins to do things like code highlighting, adding anchors to headings, and organizing images.

Since Gatsby Remark plugins allow us to look at the Markdown AST of our pages at build time, we were able to create an internal link checker that scans our Markdown for anchor elements and compares them to known page slugs and heading IDs. This helps us to avoid deploying updates containing broken links, without the need to host the changes and check links with third-party software. You can see how we achieve this in [`gatsby-remark-check-links`](https://github.com/trevorblades/gatsby-remark-check-links).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this in the Gatsby docs! 😄

@marcysutton marcysutton added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Jul 3, 2019
@marcysutton marcysutton merged commit 8a28367 into gatsbyjs:master Jul 3, 2019
@trevorblades
Copy link
Contributor Author

@marcysutton thank you for reviewing and fixing those things! 😁

@trevorblades trevorblades deleted the docs/making-docs-awesome branch July 3, 2019 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: merge on green Gatsbot will merge these PRs automatically when all tests passes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants