Skip to content

(MAINT) Document the diagnostic logging command #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2022
Merged

(MAINT) Document the diagnostic logging command #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/docs/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ Opens the dashboard with your Markdown pages overview. If you did not yet initia

ID: `frontMatter.dashboard`

### Diagnostic logging

Opens a virtual Markdown document with detailed information about your Front Matter configuration.

ID: `frontMatter.diagnostics`

### Insert image into your content

Allows you to quickly insert an image reference in the Markdown file.
Expand Down
4 changes: 4 additions & 0 deletions content/docs/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ Contents of the `blog.json` file:
}
```

### Reviewing composed settings

You can inspect your composed settings with the [diagnostic logging](commands.md#diagnostic-logging) command, which shows you the [Complete `frontmatter.json` config](troubleshooting.md#inspecting-configuration-behavior) in a virtual Markdown document. Use that output to verify that your split configuration settings are applied the way you expect.

## Available settings

### frontMatter.content.autoUpdateDate
Expand Down
12 changes: 12 additions & 0 deletions content/docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,18 @@ The extension logs information, warnings, and errors into the Visual Studio Code

![Troubleshooting - Show the output of what the extension has been performing](/releases/v5.8.0/troubleshooting-output.png)

## Inspecting configuration behavior

With the [diagnostic logging](commands.md#diagnostic-logging) command, you can see your current configuration and related information in a virtual Markdown document.

The document has several sections:

- **Folders** lists the entries defined in `frontMatter.content.pageFolders` by their title and the full path to each folder.
- **Workspace folder** notes the full path to your project's workspace.
- **Total files** notes the total file count for your workspace.
- **Folders to search files** lists the count for discovered files by type in your content folders and includes the search glob used.
- **Complete frontmatter.json config** shows the current configuration JSON. If you [split your configuration settings](settings.md#splitting-your-settings-in-multiple-files), it shows the fully composed configuration.

## Feature migrations

Sometimes it happens features get renamed or removed, under this section we will show you how to migrate your configuration to the new version.
Expand Down