Added slug documentation

Author: estruyf

.github/workflows/settings-verification.yml

@@ -12,15 +12,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
-          cache: 'npm'
+          node-version: 18
+          cache: "npm"
 
       - name: Install the dependencies
         run: npm ci
-      
+
       - name: Verify missing settings
         run: node scripts/verify-settings.js ${{ github.ref_name }}
-

components/Page/DocsLayout.tsx

@@ -20,7 +20,7 @@ export const DocsLayout: React.FunctionComponent<React.PropsWithChildren<IDocsLa
   return (
     <div className={`lg:ml-72 xl:ml-80`}>
 
-      <aside className={`fixed inset-y-0 left-0 z-40 contents w-72 overflow-y-auto px-6 pt-4 pb-8 lg:block xl:w-80 lg:pr-8 lg:border-r lg:border-vulcan-300`}>
+      <aside className={`fixed bg-vulcan-600 inset-y-0 left-0 z-40 contents w-72 overflow-y-auto px-6 pt-4 pb-8 lg:block xl:w-80 lg:pr-8 lg:border-r lg:border-vulcan-300`}>
         <div className='ml-auto'>
           <Header navItems={navItems} />
         </div>

content/changelog/CHANGELOG.md

@@ -5,14 +5,18 @@
 ### ✨ New features
 
 - [#731](https://github.com/estruyf/vscode-front-matter/issues/731): Added the ability to map/unmap taxonomy to multiple pages at once
+- [#746](https://github.com/estruyf/vscode-front-matter/issues/746): Placeholder support added to to the `slug` field
 - [#749](https://github.com/estruyf/vscode-front-matter/issues/749): Ability to set your own filters on the content dashboard with the `frontMatter.content.filters` setting
 
 ### 🎨 Enhancements
 
+- [#673](https://github.com/estruyf/vscode-front-matter/pull/673): Added git settings to the welcome view and settings view
 - [#727](https://github.com/estruyf/vscode-front-matter/pull/727): Updated Japanese translations thanks to [mayumihara](https://github.com/mayumih387)
 - [#737](https://github.com/estruyf/vscode-front-matter/issues/737): Optimize the grid layout of the content and media dashboards
+- [#739](https://github.com/estruyf/vscode-front-matter/pull/739): New Git settings to disable and require a commit message
 - [#741](https://github.com/estruyf/vscode-front-matter/issues/741): Added message on the content dashboard when content is processed
 - [#747](https://github.com/estruyf/vscode-front-matter/issues/747): The `@frontmatter/extensibility` dependency now supports scripts for placeholders
+- [#752](https://github.com/estruyf/vscode-front-matter/issues/752): Placeholder support in default `list` field values
 
 ### ⚡️ Optimizations
 

content/docs/commands.md

@@ -3,7 +3,7 @@ title: Commands
 slug: commands
 description: null
 date: 2021-08-30T16:13:00.546Z
-lastmod: 2023-09-11T07:58:42.087Z
+lastmod: 2024-02-13T09:43:12.442Z
 weight: 900
 ---
 
@@ -133,26 +133,7 @@ ID: `frontMatter.createContent`
 This command generates a clean slug for your content. It removes known stop words, punctuations, and
 special characters.
 
-Example:
-
-```yaml
----
-title: Just a sample page with a title
-slug: sample-page-title
----
-```
-
-You can also specify a prefix and suffix, which can be added to the slug if you want. Use the
-following settings to do this: `frontMatter.taxonomy.slugPrefix` and
-`frontMatter.taxonomy.slugSuffix`.
-
-By default, both prefix and suffix settings are not provided, which mean it would not add anything
-extra to the slug.
-
-Another setting is to allow you to sync the filename with the generated slug. The setting you need
-to turn on enable for this is `frontMatter.taxonomy.alignFilename`.
-
-> **Info**: At the moment, the extension only supports English stopwords.
+> **Info**: You can read more about the slug in the [slug documentation](/docs/content-creation/slug).
 
 ID: `frontMatter.generateSlug`
 

content/docs/content-creation/content-type.md

@@ -3,7 +3,7 @@ title: Content types
 slug: content-creation/content-types
 description: null
 date: 2022-03-14T08:43:17.483Z
-lastmod: 2023-12-08T09:13:41.283Z
+lastmod: 2024-02-13T09:20:18.028Z
 weight: 200.1
 ---
 
@@ -130,6 +130,7 @@ For the content type you can configure the following properties:
 | `template`        | `string`                                 | Specify a path to a template file that will be used when creating new content with the content type                                                                | `null`        |
 | `allowAsSubContent` | `boolean`                              | Allow the content type to be used as sub-content                                                                                                                   | `false`       |
 | `isSubContent`    | `boolean`                                | Defines the content type as sub-content                                                                                                                            | `false`       |
+| `slugTemplate`    | `boolean`                                | Defines the template for the `slug`                                                                                                                                | `{{title}}`   |
 
 ## Define your own type
 

content/docs/content-creation/fields.md

@@ -3,7 +3,7 @@ title: Fields
 slug: content-creation/fields
 description: null
 date: 2022-03-14T08:42:21.626Z
-lastmod: 2023-12-08T08:57:08.344Z
+lastmod: 2024-02-13T09:46:22.485Z
 weight: 200.2
 ---
 
@@ -822,7 +822,7 @@ slug: version-8-0-0-release-notes
 ```
 
 > **Info**: The slug is generated based on the title of the page. More information about it can be
-> found in the [generate slug][15] command section.
+> found in the [slug documentation][15] section.
 
 ## contentRelationship
 
@@ -958,7 +958,7 @@ want to group fields together.
 [12]: /assets/block-field-type.png
 [13]: /releases/v7.3.0/datafile-field.png
 [14]: /releases/v8.0.0/slug-field.png
-[15]: /docs/commands#generate-slug-based-on-content-title
+[15]: /docs/content-creation/slug
 [16]: /releases/v8.1.0/section-divider.png
 [17]: /releases/v8.1.0/section-heading.png
 [18]: /docs/experimental#enable-experimental-features

content/docs/content-creation/placeholders.md

@@ -3,7 +3,7 @@ title: Placeholders
 slug: content-creation/placeholders
 description: null
 date: 2022-03-14T08:42:21.626Z
-lastmod: 2024-01-31T16:32:05.190Z
+lastmod: 2024-02-13T09:22:26.586Z
 weight: 200.4
 ---
 
@@ -31,7 +31,7 @@ automatically fill in values when creating a new content.
 
 | Placeholder             | Description                                                | Works for                                             |
 | ----------------------- | ---------------------------------------------------------- | ----------------------------------------------------- |
-| `{{fm.<field name>}}`   | The value of the field in the front matter                 | `previewPath` on the page folder or the content-type. |
+| `{{fm.<field name>}}`   | The value of the field in the front matter                 | `slugTemplate` and `previewPath` properties.          |
 | `{{pathToken.<index>}}` | The value of the path token at the index                   | `previewPath` on the page folder or the content-type. |
 | `{{pathToken.relPath}}` | The relative value path staring from the page folder' path | `previewPath` on the page folder or the content-type. |
 
@@ -149,7 +149,7 @@ Here is an example of a dynamic `uniqueId` placeholder:
 #### Placeholder script
 
 To get started, you first need to install the
-[@frontmatter/extensibility](https://www.npmjs.com/package/@frontmatter/extensibility) 
+[@frontmatter/extensibility](https://www.npmjs.com/package/@frontmatter/extensibility)
 dependency.
 
 ```bash

content/docs/content-creation/slug.md

@@ -0,0 +1,112 @@
+---
+title: Slug
+slug: content-creation/slug
+description: null
+date: 2024-02-13T09:28:37.205Z
+lastmod: 2024-02-13T09:48:46.199Z
+weight: 200.5
+---
+
+# Slug
+
+The slug is the part of the URL that identifies a page in a human-readable form.
+It is usually derived from the title of the page, but Front Matter CMS allows
+you to define a custom slug.
+
+## Default slug
+
+The default slug is derived from the title of the page. It is automatically
+generated when you create a new page. The default slug is a URL-friendly version
+of the title, with all letters in lowercase, spaces replaced with hyphens,
+removes stop words, and special characters.
+
+```yaml {{ "title": "Example of the default slug" }}
+---
+title: Just a sample page with a title
+slug: sample-page-title
+---
+```
+
+> **Info**: The extension only supports English stopwords.
+
+## Custom slug
+
+You can define a custom slug for your pages and it can be defined on global
+level or per content type.
+
+### Global level
+
+You can define a custom slug template for all pages in the `frontMatter.taxonomy.slugTemplate`
+setting. The template can contain [placeholders][01] that will be replaced with the
+actual values when creating a new page.
+
+```json {{ "title": "Example of the global slug template" }}
+{
+  "frontMatter.taxonomy.slugTemplate": "{{year}}/{{month}}/{{title}}"
+}
+```
+
+> **Info**: The `{{title}}` placeholder in the slug template will be replaced with
+> what you typically get from the default slug.
+
+### Per content type
+
+You can define a custom slug template for each content type in the
+`frontMatter.taxonomy.contentTypes` setting. Similar to the global slug template,
+the template can contain placeholders that will be replaced with the actual
+values when creating a new page.
+
+```json {{ "title": "Example of the content type slug template" }}
+{
+  "frontMatter.taxonomy.contentTypes": [
+    {
+      "name": "post",
+      "slugTemplate": "{{year}}/{{month}}/{{title}}",
+      ...
+    }
+  ]
+}
+```
+
+## Additional settings
+
+### Prefix and suffix
+
+You can also specify a prefix and suffix, which can be added to the slug if you
+want. Use the following settings to do this: `frontMatter.taxonomy.slugPrefix`
+and `frontMatter.taxonomy.slugSuffix`.
+
+```json {{ "title": "Example of the slug prefix and suffix" }}
+{
+  "frontMatter.taxonomy.slugPrefix": "/",
+  "frontMatter.taxonomy.slugSuffix": "/"
+}
+```
+
+```yaml {{ "title": "Example slug in combination with the prefix and suffix" }}
+---
+title: Just a sample page with a title
+slug: /sample-page-title/
+---
+```
+
+By default, both prefix and suffix settings are not provided, which mean it would
+not add anything extra to the slug.
+
+### Align filename with slug
+
+Another setting is to allow you to sync the filename with the generated slug. The
+setting you need to turn on enable for this is `frontMatter.taxonomy.alignFilename`.
+
+```json {{ "title": "Example of the align filename with slug" }}
+{
+  "frontMatter.taxonomy.alignFilename": true
+}
+```
+
+When you update the slug of the page, the filename will be automatically
+updated to match the slug.
+
+<!-- Link References -->
+
+[01]: /docs/content-creation/placeholders

content/docs/settings/available-settings.md

@@ -3,7 +3,7 @@ title: Settings overview
 slug: settings/overview
 description: null
 date: 2023-02-13T16:44:09.618Z
-lastmod: 2023-12-08T09:03:00.096Z
+lastmod: 2024-02-13T09:17:07.601Z
 weight: 1100.2
 ---
 
@@ -424,6 +424,20 @@ Specify the commit message you want to use for the sync.
 - Type: `string`
 - Default: `Synced by Front Matter`
 
+### frontMatter.git.disableOnBranches
+
+Specify the branches on which you want to disable the Git actions.
+
+- Type: `array`
+- Default: `[]`
+
+### frontMatter.git.requiresCommitMessage
+
+Specify the branches on which you want to require a commit message.
+
+- Type: `array`
+- Default: `[]`
+
 ### frontMatter.git.submodule.push
 
 Specify if you want to push the submodule changes to the remote repository.
@@ -760,6 +774,14 @@ Specify a suffix for the slug.
 - Type: `string`
 - Default: `""`
 
+### frontMatter.taxonomy.slugTemplate
+
+Specify the template for the slug. If you use `{{title}}`, it will create a clean slug based on the
+title.
+
+- Type: `string`
+- Default: `{{title}}`
+
 ### frontMatter.taxonomy.tags
 
 Specifies the tags which can be used in the Front Matter.