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

👥 remove strip markdown and remark #2316

Merged
merged 4 commits into from
Oct 10, 2024

Conversation

joshbermanssw
Copy link
Contributor

@joshbermanssw joshbermanssw commented Oct 9, 2024

So we had a PR #2214 to update a dependency remark

However i noticed this one dependency was only being used once througout the entire code base for a singular method. Specifically it was beign used to remove markdown syntax from our .md and .mdx files so that we can index them to use in our algolia searches.

In this pr i :

  • removed the strip-markdown and remark dependencies
  • removed indexing on guides as we moved them into docs
  • re-wrote the stripMarkdown method in our blog_helper.ts modelled after https://github.com/zuchka/remove-markdown
  • added a test-case to ensure our updated method works for an edge case i found whilst building the new function
Screenshot 2024-10-09 at 8 55 28 am

Figure: ✅ Algolia powered Doc search working

Screenshot 2024-10-09 at 5 38 13 pm

Figure: ✅ All test cases passing!

@joshbermanssw joshbermanssw requested a review from a team as a code owner October 9, 2024 06:48
Copy link

vercel bot commented Oct 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tina-io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 9, 2024 9:21am

utils/blog_helpers.ts Outdated Show resolved Hide resolved
diff.txt Outdated Show resolved Hide resolved
@joshbermanssw joshbermanssw merged commit 9e93424 into main Oct 10, 2024
4 checks passed
@joshbermanssw joshbermanssw deleted the remove-remark-and-strip-markdown branch October 10, 2024 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants