adam/vscode-front-matter
1
0
Fork 0
mirror of https://github.com/estruyf/vscode-front-matter.git synced 2026-07-06 18:01:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
Elio Struyf
2020-08-22 18:16:01 +02:00
parent c4908ab1d8
commit 9a98b4ee57
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -14
View File
@@ -1,20 +1,20 @@
# VSCode Front Matter Helpers
[![Version](https://vsmarketplacebadge.apphb.com/version/eliostruyf.vscode-front-matter.svg)](https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter)
  
[![Installs](https://vsmarketplacebadge.apphb.com/installs/eliostruyf.vscode-front-matter.svg)](https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter)
  
[![Rating](https://vsmarketplacebadge.apphb.com/rating/eliostruyf.vscode-front-matter.svg)](https://marketplace.visualstudio.com/items?itemName=eliostruyf.vscode-front-matter&ssr=false#review-details)
> **Info**: Extension is still in development, but can already be tested out.
This VSCode extension simplifies working with front matter of your markdown articles when using a static site generator like Hugo, Jekyll, Hexo, NextJs, Gatsby, and many more... For example, with the extension, you can keep a list of used tags, categories and add/remove them from your article.
This VSCode extension simplifies working with front matter of your markdown articles when using a static site generator like: Hugo, Jekyll, Hexo, NextJs, Gatsby, and many more... For example, with the extension you can keep a list of used tags, categories and add/remove them from your article.
The extension will automatically verify if your title and description are SEO compliant. If this would not be the case, it will give you a warning.
> If you see something missing in your article creation flow, please feel free to reach out.
## Available commands:
**Front Matter: Create <tag | category>**
Creates a new <tag | category> and allows you to automatically include it into your post
Creates a new <tag | category> and allows you to include it into your post automatically
![Create tag or category](./assets/create-tag-category.gif)
@@ -30,19 +30,19 @@ Export all the already used tags & categories in your articles/posts/... to your
**Front Matter: Remap or remove tag/category in all articles**
This is commands helps you quickly update/remap or delete a tag or category in all your markdown files. You'll be asked to select the taxonomy type (*tag* or *category*), the old taxonomy value and the new one (leave the input field *blank* to remove the tag/category).
This command helps you quickly update/remap or delete a tag or category in your markdown files. The extension will ask you to select the taxonomy type (*tag* or *category*), the old taxonomy value, and the new one (leave the input field *blank* to remove the tag/category).
> **Info**: Once the remapping/deleting process is completed. The taxonomy tags/categories will be updated in your user settings.
> **Info**: Once the remapping/deleting process is completed. The user settings will be updated with all new taxonomy tags/categories.
**Front Matter: Set current date**
Update the `date` property of the current article/post/... to the current date & time.
> **Optional**: if you want, you can specify the format of the date property by adding your own preference in your settings. Settings key: `frontMatter.taxonomy.dateFormat`. Check [date-fns formating](https://date-fns.org/v2.0.1/docs/format) for more information which patterns you can use.
**Optional**: if you want, you can specify the date property format by adding your preference in your settings. Settings key: `frontMatter.taxonomy.dateFormat`. Check [date-fns formatting](https://date-fns.org/v2.0.1/docs/format) for more information on which patterns you can use.
**Front Matter: Generate slug based on article title**
Generates a clean slug for your article. It removes known stop words, punctuations, and special characters.
This command generates a clean slug for your article. It removes known stop words, punctuations, and special characters.
Example:
```
@@ -50,9 +50,9 @@ title: Just a sample page with a title
slug: sample-page-title
```
If you want, you can also specify a prefix and suffix which can be added to the slug. Use the following settings to do this: `frontMatter.taxonomy.slugPrefix` and `frontMatter.taxonomy.slugSuffix`. By default both options are not provided and will not add anything to the slug.
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 options are not provided and will not add anything to the slug.
> **Info**: At the moment only English stop words are supported.
> **Info**: At the moment, only English stop words are supported.
## Where is the data stored?
@@ -67,7 +67,7 @@ The tags and categories are stored in the project VSCode user settings. You can
## Additional extension settings
The extension has more settings which allow you to further configure it to your needs. Here is a list of settings which you can set:
The extension has more settings that allow you to configure it to your needs further. Here is a list of settings which you can set:
- `frontMatter.taxonomy.frontMatterType`
- Specify which Front Matter language you want to use. The extension supports `YAML` (default) and `TOML`.
@@ -79,7 +79,7 @@ The extension has more settings which allow you to further configure it to your
```
- `frontMatter.taxonomy.indentArrays`
- Specify if arrays in front matter are indented. Default: `true`. If you do not want to indent the array values, you can update it with the following setting change:
- Specify if arrays in the front matter are indented. Default: `true`. If you do not want to indent the array values, you can update it with the following setting change:
```json
{
@@ -88,7 +88,7 @@ The extension has more settings which allow you to further configure it to your
```
- `frontMatter.taxonomy.noPropertyValueQuotes`
- Specify the property names of which you want to remove the quotes in the output value. **Warning**: only use this when you know what you are doing. If you want to for instance remove the quotes from the date property, you can add the following:
- Specify the property names of which you want to remove the quotes in the output value. **Warning**: only use this when you know what you are doing. If you want to, for instance, remove the quotes from the date property, you can add the following:
```json
{