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

Update install instructions for SvelteKit #31

Open
Thunderforge opened this issue Sep 29, 2021 · 6 comments
Open

Update install instructions for SvelteKit #31

Thunderforge opened this issue Sep 29, 2021 · 6 comments

Comments

@Thunderforge
Copy link

SvelteKit is now the default way to build a Svelte app. The Svelte Preprocess Markdown documentation has install instructions that are not compatible with SvelteKit (for instance, it says to edit rollup.config.js, when in SvelteKit this has been migrated to svelte.config.js.

I would like to request that the install instructions be changed to include instructions for SvelteKit.

@akauppi
Copy link

akauppi commented Oct 4, 2021

I’m sure you can provide the necessary diff as a PR. :)

@Thunderforge
Copy link
Author

Thunderforge commented Oct 6, 2021

I have only been using Svelte and SvelteKit for about a week. In fact, I submitted this issue on my second day of using it because I had no idea how to install this preprocessor with SvelteKit. So it would probably be best if someone with more experience could update the documentation.

@magnus-ISU
Copy link

Would be nice if this could be done. I am also a svelte newbie wanting to create a blog as a simple ongoing project, and its unfortunate this project doesn't work anymore because it seems very useful for me.

@magnus-ISU
Copy link

Until then, it seems you can use mdsvex which has also not updated their documentation but at least has a couple of examples of it working.

@magnus-ISU
Copy link

It seems it wouldn't be that difficult to do. However, I'll probably be using mdsvex because it seems more fully featured so I won't make a MR.

@jedfoster
Copy link

FWIW, this config worked for me:

import { markdown } from 'svelte-preprocess-markdown';

const config = {
  kit: {
    // ... boilerplate SvelteKit configs
  },
  extensions: ['.svelte', '.md'],
  preprocess: [
    markdown(),
  ],
};

Here's the complete config. The relevant lines being 3 and 30-33

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

No branches or pull requests

4 participants