Skip to content

Commit 6272092

Browse files
committed
Merge branch 'dev' of github.com:FrontMatter/web-documentation-nextjs into dev
2 parents 81c776d + a50b426 commit 6272092

File tree

12 files changed

+207
-91
lines changed

12 files changed

+207
-91
lines changed

.github/workflows/settings-verification.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,6 @@ jobs:
2323

2424
- name: Verify missing settings
2525
run: node scripts/verify-settings.js ${{ github.ref_name }}
26+
27+
- name: Verify missing commands
28+
run: node scripts/verify-commands.js ${{ github.ref_name }}

components/Page/DocsLayout.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ export const DocsLayout: React.FunctionComponent<React.PropsWithChildren<IDocsLa
1818
const mendableRef = React.useRef<HTMLDivElement>(null);
1919

2020
return (
21-
<div className={`lg:ml-72 xl:ml-80`}>
21+
<div className={`lg:ml-72 xl:ml-96`}>
2222

23-
<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`}>
23+
<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-96 lg:pr-8 lg:border-r lg:border-vulcan-300`}>
2424
<div className='ml-auto'>
2525
<Header navItems={navItems} />
2626
</div>

components/Page/Header.tsx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ export interface IHeaderProps {
1212
navItems?: PageFrontMatter[];
1313
}
1414

15-
const Header: React.FunctionComponent<IHeaderProps> = forwardRef(({navItems}: React.PropsWithChildren<IHeaderProps>, ref: ForwardedRef<HTMLElement>
16-
) => {
15+
const Header: React.FunctionComponent<IHeaderProps> = forwardRef(({ navItems }: React.PropsWithChildren<IHeaderProps>, ref: ForwardedRef<HTMLElement>
16+
) => {
1717
const router = useRouter();
1818

1919
const isDocs = useMemo(() => {
2020
return router.pathname.startsWith('/docs');
2121
}, [router.pathname]);
22-
22+
2323
return (
2424
<>
2525
<header
26-
ref={ref}
27-
className={`fixed inset-x-0 top-0 z-50 flex h-16 lg:h-20 items-center justify-between px-4 transition sm:px-6 lg:z-30 lg:px-8 bg-vulcan-500/80 backdrop-blur-lg ${isDocs ? "right-0 lg:left-72 xl:left-80" : ""}`}>
26+
ref={ref}
27+
className={`fixed inset-x-0 top-0 z-50 flex h-16 lg:h-20 items-center justify-between px-4 transition sm:px-6 lg:z-30 lg:px-8 bg-vulcan-500/80 backdrop-blur-lg ${isDocs ? "right-0 lg:left-72 xl:left-96" : ""}`}>
2828

2929
<div className="flex items-center justify-between lg:hidden w-full">
3030
<Home className='h-12' />
@@ -35,12 +35,12 @@ const Header: React.FunctionComponent<IHeaderProps> = forwardRef(({navItems}: Re
3535

3636
<div className={`flex items-center gap-4`}>
3737
<Searchbox />
38-
38+
3939
<MobileNavigation navItems={navItems} />
4040
</div>
4141
</div>
4242

43-
<div className={`hidden lg:flex items-center w-full ${ isDocs ? "" : "max-w-7xl mx-auto"}`}>
43+
<div className={`hidden lg:flex items-center w-full ${isDocs ? "" : "max-w-7xl mx-auto"}`}>
4444
<div className="flex items-center justify-between w-full">
4545
{
4646
!isDocs && (
@@ -49,8 +49,8 @@ const Header: React.FunctionComponent<IHeaderProps> = forwardRef(({navItems}: Re
4949
}
5050

5151
<div className="flex items-center gap-6 ml-auto">
52-
<GlobalNavigation
53-
listClassName='flex gap-6'/>
52+
<GlobalNavigation
53+
listClassName='flex gap-6' />
5454

5555
<SocialNavigation />
5656

content/docs/commands.md

Lines changed: 39 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Commands
33
slug: commands
44
description: null
55
date: 2021-08-30T16:13:00.546Z
6-
lastmod: 2024-02-13T09:43:12.442Z
7-
weight: 900
6+
lastmod: 2024-02-27T08:47:18.318Z
7+
weight: 1100
88
---
99

1010
# Commands
@@ -33,7 +33,7 @@ Some of the commands do also have a default keyboard binding for quick access.
3333
- Mac: <kbd>shift</kbd> + <kbd>cmd</kbd> + <kbd>P</kbd>
3434
- Use one of the following commands
3535

36-
## Available commands
36+
## Useful commands
3737

3838
### Initialize project
3939

@@ -49,84 +49,57 @@ the welcome screen will be shown.
4949

5050
ID: `frontMatter.dashboard`
5151

52-
### Diagnostic logging
53-
54-
Opens a virtual Markdown document with detailed information about your Front Matter configuration.
55-
56-
ID: `frontMatter.diagnostics`
57-
58-
### Insert media into your content
59-
60-
Allows you to quickly insert an media reference in the Markdown file.
61-
62-
ID: `frontMatter.insertMedia`
63-
64-
### Insert snippet into your content
65-
66-
Allows you to quickly insert a snippet in the Markdown file.
67-
68-
ID: `frontMatter.insertSnippet`
69-
70-
### Create category
52+
### Open media dashboard
7153

72-
Creates a new category and allows you to include it into your post automatically.
54+
Opens the media dashboard with all your media files.
7355

74-
ID: `frontMatter.createCategory`
56+
ID: `frontMatter.dashboard.media`
7557

76-
### Create tag
58+
### Open snippet dashboard
7759

78-
Creates a new tag and allows you to include it into your post automatically.
60+
Opens the snippet dashboard with all your snippets.
7961

80-
ID: `frontMatter.createTag`
62+
ID: `frontMatter.dashboard.snippets`
8163

82-
### Insert categories
64+
### Open data dashboard
8365

84-
Inserts a selected categories into the front matter of your article/post/... - When using this
85-
command, the Front Matter panel opens and focuses on the specified type.
66+
Opens the data dashboard with all your data files.
8667

87-
ID: `frontMatter.insertCategories`
68+
ID: `frontMatter.dashboard.data`
8869

89-
### Insert tags
70+
### Open taxonomy dashboard
9071

91-
Inserts a selected tags into the front matter of your article/post/... - When using this command,
92-
the Front Matter panel opens and focuses on the specified type.
72+
Opens the taxonomy dashboard with all your categories and tags.
9373

94-
ID: `frontMatter.insertTags`
74+
ID: `frontMatter.dashboard.taxonomy`
9575

96-
### Export all tags & categories to your settings
97-
98-
Export all the already used tags & categories in your articles/posts/... to your user settings.
76+
### Insert media into your content
9977

100-
ID: `frontMatter.exportTaxonomy`
78+
Allows you to quickly insert an media reference in the Markdown file.
10179

102-
### Remap or remove tag/category in all articles
80+
ID: `frontMatter.insertMedia`
10381

104-
This command helps you quickly update/remap or delete a tag or category in your markdown files. The
105-
extension will ask you to select the taxonomy type (tag or category), the old taxonomy value, and
106-
the new one (leave the input field blank to remove the tag/category).
82+
### Insert snippet into your content
10783

108-
> **Info**: Once the remapping/deleting process completes, your VS Code settings update with all new
109-
> taxonomy tags/categories.
84+
Allows you to quickly insert a snippet in the Markdown file.
11085

111-
ID: `frontMatter.remap`
86+
ID: `frontMatter.insertSnippet`
11287

113-
### Create a template from current file
88+
### Create new content
11489

115-
This command allows you to create a new template from the current open Markdown file. It will ask
116-
you for the name of the template and if you want to keep the current file its content in the
117-
template.
90+
With this command, you can easily create content in your project from the defined content types.
11891

119-
ID: `frontMatter.createTemplate`
92+
ID: `frontMatter.createContent`
12093

121-
### Create new content from defined content type or template
94+
### Create new translation
12295

123-
With this command, you can easily create content in your project from the defined content types or
124-
templates.
96+
This command allows you to create a new translation for the current content if the
97+
multilingual feature is enabled.
12598

126-
> **Info**: The command will use the `frontMatter.templates.prefix` setting in order to add a prefix
127-
> (default: `yyyy-MM-dd`) on the filename.
99+
> **Info**: More information about the multilingual feature can be found in the
100+
> [multilingual documentation](/docs/content-creation/multilingual).
128101
129-
ID: `frontMatter.createContent`
102+
ID: `frontMatter.i18n.create`
130103

131104
### Generate slug based on content title
132105

@@ -149,24 +122,22 @@ Open the site preview of your content in VS Code.
149122

150123
ID: `frontMatter.preview`
151124

152-
### Promote settings from local to team level
153-
154-
This command allows you to promote all local settings from within your `.vscode/settings.json` file
155-
to be promoted to the projects team configuration `frontmatter.json` file.
156-
157-
ID: `frontMatter.promoteSettings`
158-
159125
### Refresh the settings
160126

161127
This command allows you to refresh the settings from the `frontmatter.json` file. This is useful
162128
when you have updated the settings manually and want to reload them.
163129

164130
ID: `frontMatter.settings.refresh`
165131

166-
## Removed commands
132+
### Clear cache
167133

168-
### Set current date
134+
Clears the CMS cache, this removes all processed pages and data from the cache so that
135+
the whole cache can be rebuilt.
169136

170-
This command has been removed, as it became obsolete since the introduction of Content Types.
137+
ID: `frontMatter.cache.clear`
138+
139+
### Diagnostic logging
140+
141+
Opens a virtual Markdown document with detailed information about your Front Matter configuration.
171142

172-
ID: `frontMatter.setDate`
143+
ID: `frontMatter.diagnostics`

content/docs/experimental/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Experimental features
33
slug: experimental
44
description: Experimental features in the Front Matter extension.
55
date: 2023-02-12T14:39:58.691Z
6-
lastmod: 2023-08-21T08:13:43.748Z
7-
weight: 910
6+
lastmod: 2024-02-26T17:52:13.588Z
7+
weight: 900
88
---
99

1010
# Experimental features

content/docs/experimental/ui-extensibility.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: UI extensibility
33
slug: experimental/ui-extensibility
44
description: UI extensibility in the Front Matter extension.
55
date: 2023-04-01T10:16:59.392Z
6-
lastmod: 2023-08-21T09:23:29.241Z
7-
weight: 910.1
6+
lastmod: 2024-02-26T17:52:22.334Z
7+
weight: 900.1
88
---
99

1010
# UI extensibility

content/docs/settings/available-settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Settings overview
33
slug: settings/overview
44
description: null
55
date: 2023-02-13T16:44:09.618Z
6-
lastmod: 2024-02-24T13:16:18.482Z
7-
weight: 1100.2
6+
lastmod: 2024-02-26T17:54:04.814Z
7+
weight: 1000.2
88
---
99

1010
# Settings overview

content/docs/settings/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Settings
33
slug: settings
44
description: null
55
date: 2021-08-30T16:13:00.546Z
6-
lastmod: 2024-02-13T08:44:01.601Z
7-
weight: 1100
6+
lastmod: 2024-02-26T17:53:54.854Z
7+
weight: 1000
88
---
99

1010
# Settings

content/docs/settings/projects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Projects
33
slug: settings/projects
44
description: Projects are useful when managing multiple sites or when you want to separate your content into different environments.
55
date: 2023-04-01T12:41:24.675Z
6-
lastmod: 2023-04-01T13:00:21.325Z
7-
weight: 1100.1
6+
lastmod: 2024-02-26T17:54:08.454Z
7+
weight: 1000.1
88
---
99

1010
# Projects

content/docs/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Troubleshooting
33
slug: troubleshooting
44
description: null
55
date: 2021-12-21T09:53:30.176Z
6-
lastmod: 2023-03-25T20:24:17.797Z
7-
weight: 1000
6+
lastmod: 2024-02-26T17:53:05.362Z
7+
weight: 950
88
---
99

1010
# Troubleshooting

0 commit comments

Comments
 (0)