solid-start icon indicating copy to clipboard operation
solid-start copied to clipboard

Remove solid-start-mdx package

Open birkskyum opened this issue 1 year ago • 5 comments

I'm trying to clean up the MDX story, so it's more clear, and so solid devs can take full advantage of recent development with twoslash, shiki etc, and it came to my attention that solid-start-mdx has become obsolete.

solid-start-mdx is not used in the with-mdx example, or the new docs, where instead we use a combination of these three:

https://www.npmjs.com/package/solid-mdx http://www.npmjs.com/package/@vinxi/plugin-mdx https://www.npmjs.com/package/@mdx-js/mdx

And the solid-site repo uses:

https://www.npmjs.com/package/solid-mdx https://www.npmjs.com/package/@mdx-js/rollup

There have also been a few community efforts in this space:

https://www.npmjs.com/package/vite-plugin-solid-markdown https://www.npmjs.com/package/solidjs-mdx

More info about solid-start-mdx:

Screenshot 2024-03-18 at 16 04 17 Screenshot 2024-03-18 at 16 04 25

birkskyum avatar Mar 18 '24 15:03 birkskyum

⚠️ No Changeset found

Latest commit: 85ae68e012b28b8238efec5427319ca050b93a77

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR
Some errors occurred when validating the changesets config:
The package or glob expression "solid-start-mdx" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.

changeset-bot[bot] avatar Mar 18 '24 15:03 changeset-bot[bot]

Do we not use it in the docs? Oh.. hmm... I thought we did by the app.config.ts

import { defineConfig } from "@solidjs/start/config";
import { docsMdx } from "solid-start-mdx";
import tailwindcss from "tailwindcss";
import { config } from "vinxi/plugins/config";

export default defineConfig({
  appRoot: "./docs",
  extensions: ["mdx", "md"],
  experimental: { islands: true },
  server: {
    preset: "cloudflare_module",
    rollupConfig: {
      external: ["__STATIC_CONTENT_MANIFEST", "node:async_hooks"]
    },
    prerender: {
      crawlLinks: true
    }
  },
  vite: {
    optimizeDeps: {
      entries: []
    },
    plugins: [
      config("tailwind", {
        css: {
          postcss: {
            plugins: [tailwindcss]
          }
        }
      } as any),
      docsMdx()
    ]
  }
});

ryansolid avatar Mar 18 '24 16:03 ryansolid

I'll look into that one - might have missed that

birkskyum avatar Mar 18 '24 16:03 birkskyum

Okay, so it's used exclusively in, and tightly bound to, https://start.solidjs.com/ a bit longer.

birkskyum avatar Mar 18 '24 17:03 birkskyum

Yep. That's the only reason exists. But it can go away soon with the new docs.

ryansolid avatar Mar 18 '24 18:03 ryansolid

Seems like it now would be better for new users if the url in the start GitHub repo pointed to here where guides and api docs are updated:

https://docs.solidjs.com/solid-start

birkskyum avatar Mar 22 '24 12:03 birkskyum