Skip to content

Commit 5c4a2bf

Browse files
committed
Documentation changes
1 parent f0e2c8f commit 5c4a2bf

17 files changed

+377
-96
lines changed

content/changelog/CHANGELOG.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,31 @@
88

99
### 🎨 Enhancements
1010

11+
- [#425](https://github.com/estruyf/vscode-front-matter/issues/425): Added support for placeholders in the content paths and previews
12+
- [#473](https://github.com/estruyf/vscode-front-matter/issues/473): Allow setting the SEO title name with the `frontMatter.taxonomy.seoTitleField` setting
1113
- [#474](https://github.com/estruyf/vscode-front-matter/issues/474): Allow to define the file prefix on content types
1214
- [#484](https://github.com/estruyf/vscode-front-matter/issues/484): Support for overriding scripts per environment type
15+
- [#494](https://github.com/estruyf/vscode-front-matter/issues/494): Support for external image URLs in previews
16+
- [#497](https://github.com/estruyf/vscode-front-matter/issues/497): Support for movie media previews in the content dashboard
17+
- [#502](https://github.com/estruyf/vscode-front-matter/issues/502): Keyboard bindings added to open dashboard, insert media, and insert snippet
18+
- [#503](https://github.com/estruyf/vscode-front-matter/issues/503): Allow making changes to the preview URL in the webview
19+
- [#504](https://github.com/estruyf/vscode-front-matter/issues/504): Allow specifying the filename for your page bundles
20+
- [#505](https://github.com/estruyf/vscode-front-matter/issues/505): Experimental Visual Studio Code theming support
1321

1422
### ⚡️ Optimizations
1523

24+
- [#496](https://github.com/estruyf/vscode-front-matter/issues/496): Make use of the `storageUri` and `globalStorageUri` for storing larger states
25+
1626
### 🐞 Fixes
1727

1828
- [#469](https://github.com/estruyf/vscode-front-matter/issues/469): Fix for using the root folder as content folder
1929
- [#470](https://github.com/estruyf/vscode-front-matter/issues/470): Fix `initialize project` dashboard description
30+
- [#480](https://github.com/estruyf/vscode-front-matter/issues/480): Updated _add missing fields_ label to _add missing fields to content-type_
2031
- [#482](https://github.com/estruyf/vscode-front-matter/issues/482): Update the description when you want to overwrite the default content type description
32+
- [#488](https://github.com/estruyf/vscode-front-matter/issues/488): Fix an issue where the `.frontmatter` folder gets created before initializing the project
33+
- [#493](https://github.com/estruyf/vscode-front-matter/issues/493): Fix an issue where a custom placeholder value is replaced by an `array` instead of a `string`
2134

22-
## [8.2.0] - 2022-12-08 - [Release notes](https://beta.frontmatter.codes/updates/v8.2.0)
35+
## [8.2.0] - 2022-12-08 - [Release notes](https://beta.frontmatter.codes/updates/v8.2.0)
2336

2437
### ✨ New features
2538

@@ -66,7 +79,7 @@
6679

6780
- [#422](https://github.com/estruyf/vscode-front-matter/issues/422): Fix in panel initialization logic
6881

69-
## [8.1.0] - 2022-09-22 - [Release notes](https://beta.frontmatter.codes/updates/v8.1.0)
82+
## [8.1.0] - 2022-09-22 - [Release notes](https://beta.frontmatter.codes/updates/v8.1.0)
7083

7184
### ✨ New features
7285

@@ -118,7 +131,7 @@
118131
- Fix missing clipboard icon for the media card action
119132
- Fix in tags rendering on content cards
120133

121-
## [8.0.0] - 2022-07-11 - [Release notes](https://beta.frontmatter.codes/updates/v8.0.0)
134+
## [8.0.0] - 2022-07-11 - [Release notes](https://beta.frontmatter.codes/updates/v8.0.0)
122135

123136
### ✨ New Features
124137

@@ -162,7 +175,6 @@
162175

163176
- [#346](https://github.com/estruyf/vscode-front-matter/issues/346): Fix media dashboard refresh action
164177

165-
166178
## [7.3.1] - 2022-05-26
167179

168180
### 🐞 Fixes
@@ -189,7 +201,6 @@
189201
- [#334](https://github.com/estruyf/vscode-front-matter/issues/334): Fix for locked content folders retrieval
190202
- [#339](https://github.com/estruyf/vscode-front-matter/issues/339): Fix for content folders without a title
191203

192-
193204
## [7.2.0] - 2022-05-02 - [Release notes](https://beta.frontmatter.codes/updates/v7.2.0)
194205

195206
### 🎨 Enhancements
@@ -231,7 +242,7 @@
231242
## [7.1.0] - 2022-04-07 - [Release notes](https://beta.frontmatter.codes/updates/v7.1.0)
232243

233244
### 🎨 Enhancements
234-
245+
235246
- [#240](https://github.com/estruyf/vscode-front-matter/issues/240): Capability added to define display modes
236247
- [#246](https://github.com/estruyf/vscode-front-matter/issues/246): Support to add multiple tags/keywords/taxonomy via comma separated values
237248
- [#293](https://github.com/estruyf/vscode-front-matter/issues/293): Support added for setting preview images in block fields
@@ -251,7 +262,7 @@
251262
- [#304](https://github.com/estruyf/vscode-front-matter/issues/304): Fix yaml stringify which caused additional fields to be added
252263
- [#305](https://github.com/estruyf/vscode-front-matter/issues/305): Fix for overflow issue in taxonomy picker
253264
- [#306](https://github.com/estruyf/vscode-front-matter/issues/306): Fix for default value of content type fields
254-
- [#311](https://github.com/estruyf/vscode-front-matter/issues/311): Fix for updating snippets
265+
- [#311](https://github.com/estruyf/vscode-front-matter/issues/311): Fix for updating snippets
255266

256267
## [7.0.0] - 2022-03-21 - [Release notes](https://beta.frontmatter.codes/updates/v7.0.0)
257268

@@ -427,7 +438,7 @@ As from this version onwards, the extension will be published to [open-vsx.org](
427438
### 🎨 Enhancements
428439

429440
- [#173](https://github.com/estruyf/vscode-front-matter/issues/173): Allow to specify your own sorting for the content dashboard
430-
- [#174](https://github.com/estruyf/vscode-front-matter/issues/174): Added option to exclude sub-directories from page/markdown content retrieval
441+
- [#174](https://github.com/estruyf/vscode-front-matter/issues/174): Added option to exclude sub-directories from page/markdown content retrieval
431442

432443
## [5.4.0] - 2021-11-05
433444

@@ -573,10 +584,10 @@ As from this version onwards, the extension will be published to [open-vsx.org](
573584

574585
- Fix typo in the `package.json` file for the preview command
575586

576-
## [2.5.0] - 2020-08-19
587+
## [2.5.0] - 2020-08-19
577588

578589
- Moved the center layout button to the other actions section
579-
- [#60](https://github.com/estruyf/vscode-front-matter/issues/60): Added the ability to open a site preview in VS Code
590+
- [#60](https://github.com/estruyf/vscode-front-matter/issues/60): Added the ability to open a site preview in VS Code
580591

581592
## [2.4.1] - 2020-08-16
582593

content/changelog/v8.3.0.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
title: Version 8.3.0 release notes
3+
description:
4+
With its latest version 8.3.0, you can now enjoy new features such as external
5+
config support, VSCode theme support, and many more...
6+
date: 2023-02-12T14:39:54.058Z
7+
lastmod: 2023-02-12T15:50:14.648Z
8+
type: changelog
9+
slug: v8.3.0
10+
---
11+
12+
## External config support
13+
14+
In this version of VSCode Front Matter now supports external config files, meaning you can store your configurations outside of the extension in a separate file. This allows for better organization and easier management of your configurations, as well as better collaboration with others.
15+
16+
## Experimental Visual Studio Code theme support
17+
18+
Finally we are introducing "experimental" support for Visual Studio Code themes. The dashboards will now adapt to the colors of your current theme.
19+
20+
This feature is experimental because there are various themes and we want to make sure that we support most of the themes out there. If you find a theme that is not supported, please [open an issue](https://github.com/estruyf/vscode-front-matter/issues) and mention the theme you are using and what can be improved.
21+
22+
<div style="display:flex;justify-items:center;">
23+
<img src="/releases/v8.3.0/theme1.png" alt="Theme example 1" style="max-width:45%" />
24+
<img src="/releases/v8.3.0/theme3.png" alt="Theme example 2" style="max-width:45%" />
25+
</div>
26+
27+
> **Info**: Find out more about this feature in the [experimental features](/docs/experimental) section.
28+
29+
## Placeholder support in content paths and previews
30+
31+
You can now use placeholders in your content paths and previews. This feature allows you to use the values of your front matter fields, path variables, and much more when creating new content or when opening a preview.
32+
33+
```json
34+
"frontMatter.content.pageFolders": [
35+
{
36+
"title": "post",
37+
"filePrefix": null,
38+
"previewPath": "/{{fm.type}}/{{pathToken.3}}/{{pathToken.4}}",
39+
"path": "[[workspace]]/content/{{year}}/{{month}}",
40+
"contentTypes": ["post"]
41+
}
42+
]
43+
```
44+
45+
The above snippet shows both new features:
46+
47+
- Allow you content to be created in a dynamic path;
48+
- Allow the preview path to be generated based on some field values and path index values.
49+
50+
When you would create a new content item, the path will be generated based on the `path` property. In this case, it will be: `[[workspace]]/content/2023/02`. The preview path will generate the following path: `/post/2023/02/<slug>`.
51+
52+
> **Info**: Read more about these placeholder features in the [special placeholders](/docs/content-creation/placeholders#special-placeholders) section.
53+
54+
## Allowing you to change the preview URL
55+
56+
In the previous version, you could only open a preview, but not change the URL. This is now possible, and it allows you to quickly test out other URLs, content, ...
57+
58+
![Allow editing of the URL](/releases/v8.3.0/site-preview.png)
59+
60+
## Movie media previews in the media dashboard
61+
62+
The media dashboard now added support for movie media previews. Similar to the images, you can now quickly watch your movies on the card.
63+
64+
## Default keybindings to open dashboard, insert media, and insert snippet
65+
66+
New in this version is the introduction of default keybindings to open the dashboard, insert media, and insert snippet.
67+
68+
| Command | Description | Windows | Mac | Linux |
69+
| --------------------------- | ------------------------------------- | ------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------- |
70+
| `frontMatter.dashboard` | Open the Front Matter dashboard | <kbd>alt</kbd> + d | <kbd>option</kbd> + d | <kbd>alt</kbd> + d |
71+
| `frontMatter.insertMedia` | Insert a media file into your content | <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>i</kbd> | <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>i</kbd> | <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>i</kbd> |
72+
| `frontMatter.insertSnippet` | Insert a snippet into your content | <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>v</kbd> | <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>v</kbd> | <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>v</kbd> |
73+
74+
> **Info**: You can find the keybindings in the [keybindings](/docs/commands#keyboard-bindings) section. You are also able to override this configuration or configure other keyboard bindings in Visual Studio Code.
75+
76+
## Related issues/enhancements
77+
78+
### ✨ New features
79+
80+
- [#407](https://github.com/estruyf/vscode-front-matter/issues/407): External config support
81+
82+
### 🎨 Enhancements
83+
84+
- [#425](https://github.com/estruyf/vscode-front-matter/issues/425): Added support for placeholders in the content paths and previews
85+
- [#473](https://github.com/estruyf/vscode-front-matter/issues/473): Allow setting the SEO title name with the `frontMatter.taxonomy.seoTitleField` setting
86+
- [#474](https://github.com/estruyf/vscode-front-matter/issues/474): Allow to define the file prefix on content types
87+
- [#484](https://github.com/estruyf/vscode-front-matter/issues/484): Support for overriding scripts per environment type
88+
- [#494](https://github.com/estruyf/vscode-front-matter/issues/494): Support for external image URLs in previews
89+
- [#497](https://github.com/estruyf/vscode-front-matter/issues/497): Support for movie media previews in the content dashboard
90+
- [#502](https://github.com/estruyf/vscode-front-matter/issues/502): Keyboard bindings added to open dashboard, insert media, and insert snippet
91+
- [#503](https://github.com/estruyf/vscode-front-matter/issues/503): Allow making changes to the preview URL in the webview
92+
- [#504](https://github.com/estruyf/vscode-front-matter/issues/504): Allow specifying the filename for your page bundles
93+
- [#505](https://github.com/estruyf/vscode-front-matter/issues/505): Experimental Visual Studio Code theming support
94+
95+
### ⚡️ Optimizations
96+
97+
- [#496](https://github.com/estruyf/vscode-front-matter/issues/496): Make use of the `storageUri` and `globalStorageUri` for storing larger states
98+
99+
### 🐞 Fixes
100+
101+
- [#469](https://github.com/estruyf/vscode-front-matter/issues/469): Fix for using the root folder as content folder
102+
- [#470](https://github.com/estruyf/vscode-front-matter/issues/470): Fix `initialize project` dashboard description
103+
- [#480](https://github.com/estruyf/vscode-front-matter/issues/480): Updated _add missing fields_ label to _add missing fields to content-type_
104+
- [#482](https://github.com/estruyf/vscode-front-matter/issues/482): Update the description when you want to overwrite the default content type description
105+
- [#488](https://github.com/estruyf/vscode-front-matter/issues/488): Fix an issue where the `.frontmatter` folder gets created before initializing the project
106+
- [#493](https://github.com/estruyf/vscode-front-matter/issues/493): Fix an issue where a custom placeholder value is replaced by an `array` instead of a `string`

content/docs/commands.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,35 @@
22
title: Commands
33
slug: commands
44
description: null
5-
date: '2021-08-30T16:13:00.546Z'
6-
lastmod: '2021-09-22T08:00:40.856Z'
5+
date: 2021-08-30T16:13:00.546Z
6+
lastmod: 2023-02-12T15:41:40.983Z
77
weight: 900
88
---
99

1010
# Commands
1111

1212
## Overview
1313

14-
Front Matter actions are also available as commands. In this section of the documentation all
15-
commands will be explained.
14+
Front Matter actions can also be done using commands. This section of the documentation will
15+
provide an explanation of all the available commands.
1616

17-
![Commands][01]
17+
<img src="/assets/commands-v6.1.0.png" alt="Commands" style="max-width: 60%" />
18+
19+
Some of the commands do also have a default keyboard binding for quick access.
20+
21+
## Keyboard bindings
22+
23+
| Command | Description | Windows | Mac | Linux |
24+
| --------------------------- | ------------------------------------- | ------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------- |
25+
| `frontMatter.dashboard` | Open the Front Matter dashboard | <kbd>alt</kbd> + d | <kbd>option</kbd> + d | <kbd>alt</kbd> + d |
26+
| `frontMatter.insertMedia` | Insert a media file into your content | <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>i</kbd> | <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>i</kbd> | <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>i</kbd> |
27+
| `frontMatter.insertSnippet` | Insert a snippet into your content | <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>v</kbd> | <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>v</kbd> | <kbd>cmd</kbd> + <kbd>shift</kbd> + <kbd>v</kbd> |
1828

1929
## Using commands
2030

2131
- Start by opening the command prompt:
22-
- Windows: ⇧+ctrl+P
23-
- Mac: ⇧+⌘+P
32+
- Linux & Windows: <kbd>shift</kbd> + <kbd>ctrl</kbd> + <kbd>P</kbd>
33+
- Mac: <kbd>shift</kbd> + <kbd>cmd</kbd> + <kbd>P</kbd>
2434
- Use one of the following commands
2535

2636
## Available commands
@@ -45,11 +55,11 @@ Opens a virtual Markdown document with detailed information about your Front Mat
4555

4656
ID: `frontMatter.diagnostics`
4757

48-
### Insert image into your content
58+
### Insert media into your content
4959

50-
Allows you to quickly insert an image reference in the Markdown file.
60+
Allows you to quickly insert an media reference in the Markdown file.
5161

52-
ID: `frontMatter.insertImage`
62+
ID: `frontMatter.insertMedia`
5363

5464
### Insert snippet into your content
5565

@@ -172,6 +182,3 @@ ID: `frontMatter.promoteSettings`
172182
This command has been removed, as it became obsolete since the introduction of Content Types.
173183

174184
ID: `frontMatter.setDate`
175-
176-
<!-- Link References -->
177-
[01]: /assets/commands-v6.1.0.png

0 commit comments

Comments
 (0)