feat: allow custom src/pages/index.astro

[Nemikolh]

This PR makes it possible to have a custom src/pages/index.astro by modifying the defaultRoutes to support an extra mode in which it does not inject the default route for /{base}.

Once this PR is merged, to enable this feature on a project, one would have to do:

import tutorialkit from '@tutorialkit/astro';
import { defineConfig } from 'astro/config';

export default defineConfig({
  integrations: [
    tutorialkit({
      // only enable the routes for the tutorial
      defaultRoutes: 'tutorial-only',
    }),
  ],
});

The alternative to this I considered was to modify index.astro so that it reads file from the src/pages/index.astro folder, however this wouldn't have worked under the eject mode as the file would end up reading itself recursively.

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 23ceb9d

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

[cloudflare-workers-and-pages]

Deploying tutorialkit-demo-page with    Cloudflare Pages

Latest commit:	23ceb9d
Status:	✅  Deploy successful!
Preview URL:	https://6f733e44.tutorialkit-demo-page.pages.dev
Branch Preview URL:	https://joan-default-route.tutorialkit-demo-page.pages.dev

View logs

[cloudflare-workers-and-pages]

Deploying tutorialkit-docs-page with    Cloudflare Pages

Latest commit:	23ceb9d
Status:	✅  Deploy successful!
Preview URL:	https://e0110403.tutorialkit-docs-page.pages.dev
Branch Preview URL:	https://joan-default-route.tutorialkit-docs-page.pages.dev

View logs

[d3lm]

When adding these things we need to make sure to add this to the docs as well and it'd be great if we can link the docs PR here as well for full transparency.

[SamVerschueren]

it'd be great if we can link the docs PR here as well for full transparency.

It'd be better to just update the docs in this PR. So it's a single PR which includes everything.

[d3lm]

Right! Forgot for a second that the docs are in the same repo 🤦‍♂️

[Nemikolh]

@d3lm, @SamVerschueren I've updated the JSDoc of the property so that the new value is explained.

Given we currently don't have any docs on https://tutorialkit.dev for our JSDocs I don't think it makes sense that I introduce that as part of this PR?

What do you think?