docs/content-creation/additional-config

[giscus[bot]]

docs/content-creation/additional-config

Get to know more about how you can use Front Matter with our documentation.

https://frontmatter.codes/docs/content-creation/additional-config

[gldraphael]

I'm having a hard time getting "preview" to work with docusaurus. It has all the docs in a docs folder in the root.

For the following structure:

/project
    /docs
        /sub-folder
            /file.md

I'd expect the path to be localhost:3000/sub-folder/file.

The following config:

"frontMatter.preview.host": "http://localhost:3000",
  "frontMatter.content.pageFolders": [
    {
      "title": "docs",
      "path": "[[workspace]]/docs",
      "previewPath": "docs"
    }
  ],

generates http://localhost:3000/26th518/file instead.

[gldraphael]

It's an internal repository, but I think I should be able to reproduce this. Will get back!

[gldraphael]

Here's a repro https://github.com/gldraphael/docusaurus-fm-exp
It does not have the 26th518 bit. But the preview link doesn't work because the preview link does not have the sub-folder in it.

The internal project has the following in frontmatter.json, but I dont see the 26th518 in it anymore either:

{
  "$schema": "https://frontmatter.codes/frontmatter.schema.json",
  "frontMatter.content.fmHighlight": true,
  "frontMatter.framework.startCommand": "npm start",
  "frontMatter.preview.host": "http://localhost:3000",
  "frontMatter.content.pageFolders": [
    {
      "title": "docs",
      "path": "[[workspace]]/docs",
      "previewPath": "docs"
    }
  ],
  "frontMatter.framework.id": "docusaurus",
  "frontMatter.content.publicFolder": "static",
  "frontMatter.dashboard.openOnStart": true
}

[estruyf]

Good news, this will be supported in 8.3.0 with the {{pathToken.relPath}} token placeholder for the previewPath property.

Check the beta documentation: https://beta.frontmatter.codes/docs/content-creation/placeholders#example-2

[alexandrstudio]

I got a similar problem as gldraphael but with Astro. I noticed that in developer mode the built pages get dynamic names. Also folders. This is the reason for these strange folders and file names. But if you put the folder name in quotes, it is no longer dynamically resolved and the preview works. My config looks like this:

"frontMatter.content.pageFolders": [
    {
      "title": "tips",
      "path": "[[workspace]]/src/content/tips",
      "previewPath": "/'tips'/",
      "contentTypes": [
        "tips"
      ]
    }
  ]

[gldraphael]

Late response, but @estruyf that worked, thank you!

My new configuration is as follows:

{
  "$schema": "https://frontmatter.codes/frontmatter.schema.json",
  "frontMatter.content.fmHighlight": true,
  "frontMatter.framework.startCommand": "npm start",
  "frontMatter.preview.host": "http://localhost:3000",
  "frontMatter.content.pageFolders": [
    {
      "title": "docs",
      "path": "[[workspace]]/docs",
      "previewPath": "{{pathToken.relPath}}/"
    }
  ],
  "frontMatter.framework.id": "docusaurus",
  "frontMatter.content.publicFolder": "static",
  "frontMatter.dashboard.openOnStart": true
}