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 MDX #732

Merged
merged 2 commits into from
Oct 4, 2024
Merged
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
9 changes: 9 additions & 0 deletions .changeset/slow-roses-buy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
'scoobie': major
---

Scoobie no longer supports MDX rendering, and so many pieces of this library have been removed.

Updating SEEK-internal codebases to use MDX v2/v3 has turned out to be challenging, and made even more challenging with the abstraction of having to do it via Scoobie.

This change returns Scoobie to be a React component library only.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
dist-storybook-tmp/
lib/
mermaid/
node_modules/

.DS_Store
Expand Down
17 changes: 2 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,14 @@

Hi there, thanks for checking out our repo!

Scoobie brings MDX support and documentation-focused components to a SEEK-standard frontend development environment.
Scoobie is a component library for SEEK documentation sites.

While third-party contributions are certainly welcome,
this library has minimal value if you aren't committed to our [design system] and [development toolkit].

SEEKers: this repo is public,
so don't commit or post anything that isn't ready for the entire world to see.

## Table of contents

- [Getting started](#getting-started)
- [I want to discuss or report something](#i-want-to-discuss-or-report-something)
- [I want to contribute a change](#i-want-to-contribute-a-change)
- [Development](#development)
- [Prerequisites](#prerequisites)
- [Git workflow](#git-workflow)
- [Testing](#testing)
- [Releases](#releases)
- [Creating a changeset](#creating-a-changeset)
- [Publishing a release](#publishing-a-release)
- [Publishing a prerelease](#publishing-a-prerelease)

## Getting started

Scoobie is documented through its [README](/README.md) and [Storybook site].
Expand Down
Loading