Uh oh!
There was an error while loading. Please reload this page.
Leverage markdown docs - #1220
Merged
Merged
Conversation
|
tylersticka
marked this pull request as ready for review
May 14, 2021 23:08
Paul-Hebert
approved these changes
May 14, 2021
Paul-Hebert
left a comment
Contributor
There was a problem hiding this comment.
Good call, I really like this approach (planning to write a micro blog post about it when I have some time)
| .replace( | ||
| /\[(.+)]\(CONTRIBUTING\.md\)/g, | ||
| '<a href="../?path=/story/contributing--page">$1</a>' | ||
| )} |
This was referenced Aug 21, 2026
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
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Overview
Our previous "Getting started" page was pretty spartan, and it had a comment warning editors to manually sync its content with our
README.mdpage. This PR uses a technique I stole from @Paul-Hebert for importing the Markdown and displaying it within a docs page.The README had a few links in it that were specific to the GitHub repository, so I used
.replaceon the imported string to make them more relevant. I also removed a Renovate badge which seemed to no longer be functional since their acquisition.Because that page now felt like a more general introduction to the project, I renamed it "Introduction." I also added our "Contributing" and "Changelog" docs, and put them all in a
docsdirectory to clean upsrca bit.Screenshots
Testing
View documentation pages in deploy preview