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

Enhancement: Allow specifying the index file name #504

Closed
furkanb opened this issue Feb 5, 2023 · 2 comments
Closed

Enhancement: Allow specifying the index file name #504

furkanb opened this issue Feb 5, 2023 · 2 comments

Comments

@furkanb
Copy link
Contributor

furkanb commented Feb 5, 2023

In SvelteKit each page is defined by a +page.svelte file. E.g.:
src/routes/blog/[slug]/+page.svelte or src/routes/blog/[slug]/+page[.md / .mdx / .svx] since we're using MDsveX.

When creating content with the FrontMatter extension the default file is named index.md. This requires the SvelteKit end user having to rename the file to +page.md so that SvelteKit can direct the route to the specified markdown file.


Assuming we have the following set on fronmatter.json

{
"frontMatter.taxonomy.contentTypes": [
    {
      "name": "default",
      "pageBundle": true,
      "fileType": "svx",
      
    }
  ],
  "frontMatter.content.pageFolders": [
    {
      "title": "blog",
      "path": "[[workspace]]/src/routes/blog",
      "filePrefix": ""
    }
  ]
}

One idea could be to be able to associate a default file name string (which defaults to index) for each content type. Like so:

"frontMatter.taxonomy.contentTypes": [
    {
      "name": "default",
      "pageBundle": true,
      "fileType": "svx",
      "defaultFileName": "+page",      <---
      
    }
  ]

Another idea could be to associate the default file name with a specific folder:

  "frontMatter.content.pageFolders": [
    {
      "title": "blog",
      "path": "[[workspace]]/src/routes/blog",
      "filePrefix": "",
      "defaultFileName": "+page"      <---
    }
  ]
}
@furkanb furkanb added the enhancement New feature or request label Feb 5, 2023
@estruyf
Copy link
Owner

estruyf commented Feb 5, 2023

Thank you @furkanb, makes a lot of sense to add this support.

Question: should the defaultFileName property you propose, include the file extension?

@furkanb
Copy link
Contributor Author

furkanb commented Feb 5, 2023

@estruyf If the default file name will be defined within the content type (frontMatter.taxonomy.contentTypes) I think it would be redundant to include the file extension since there's already a fileType property. So I would suggest defining the default file name property within the content type, this way the user could have the option to change either the file name or the file type.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants