Documenation updates and preparations for 4.0.0 release

This commit is contained in:
Elio Struyf
2021-09-20 11:23:34 +02:00
parent 04ccdbb646
commit 7a702f09a0
12 changed files with 86 additions and 29 deletions
+2 -1
View File
@@ -7,7 +7,8 @@
- [#103](https://github.com/estruyf/vscode-front-matter/issues/103): Added title and description field to the metadata section
- [#104](https://github.com/estruyf/vscode-front-matter/issues/104): Allow to set images in front matter from the metadata panel section
- [#105](https://github.com/estruyf/vscode-front-matter/issues/105): Content Type support with backwards compatibility
- [#107](https://github.com/estruyf/vscode-front-matter/issues/107): Number field support added in content types fields
- [#107](https://github.com/estruyf/vscode-front-matter/issues/107): Number field support added in content type fields
- [#108](https://github.com/estruyf/vscode-front-matter/issues/108): Choice field support added in content type fields
## [3.1.0] - 2021-09-10
+6
View File
@@ -123,6 +123,12 @@ Open the site preview of your article in VS Code.
ID: `frontMatter.preview`
## Promote settings from local to team level
This command allows you to promote all local settings from within your `.vscode/settings.json` file to be promoted to the projects team configuration `frontmatter.json` file.
ID: `frontMatter.promoteSettings`
## Removed commands
### Set current date
+12 -3
View File
@@ -11,11 +11,20 @@ weight: 7
## Overview
Most of the actions are configurable to your needs. In this part of the documentation all settings are explained.
Most of Front Matter is configurable to your needs. In this part of the documentation all settings are explained.
## Where is the data stored?
## Team settings and local settings
The extension stores all settings in the VS Code user settings file located in your project under `.vscode/settings.json`.
Since version 4 of Front Matter, Team settings got introduced. Teams settings allow you to have all settings on the project/solution level. You will be able to override them on user/local level (`.vscode/settings.json`).
The purpose of team settings is to share the global configuration of your CMS configuration. This way, your whole team can use the same tags/categories but apply their changes locally.
As you do not typically share your `.vscode/settings.json` configuration, we went for a `frontmatter.json` file on the root of your project/solution. The settings you provide in this JSON file are the same as you can configure on a local level. This allows you to easily copy, move settings from team to local level and vice versa.
## Migrate local settings to team settings
To allow you to easily migrate already defined settings, you can run the `Promote settings from local to team level` command.
## Available settings