You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-35Lines changed: 32 additions & 35 deletions
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
8
8
Important!!! For users that are upgrading from v0.0.5 or earlier please see [Upgrading Notes File](UPGRADING.md) for important information regarding changes from the older versions..
9
9
10
-
Adds inline file links to notes in markdown files.
10
+
Maintains 2 lists of notes in markdown file format. Notes are either project specific or global. Project notes are only available when that project is loaded while global notes are accessible at all times. Notes may be viewed in preview or edit modes. [Links](#using-file-links) to both project and global notes can be embedded within your source code.
11
11
12
12
Adds TODO syntax highlighting support to comments in your source files.
13
13
@@ -18,50 +18,44 @@ Note: This extension provides syntax highlighting for definable keywords within
18
18
It is possible to [add new extensions](SETTINGS.md) to the settings file. If you are using a programming language that this extension does not support and you need assistance adding it to the settings file, please submit an issue on my [Github Issues page](https://github.com/willasm/project-notes/issues) and I will add support for it to this extension.
19
19
20
20
## Features
21
-
- Link to project note files in Markdown format.
22
-
- Link to global note files in Markdown format.
21
+
- Maintains 2 lists of notes, one project specific and one global.
22
+
- Insert Links to project note files inside your codes comments.
23
+
- Insert Links to global note files inside your codes comments.
24
+
- Global notes location can be set to any preferred location (uses this extensions global storage location by default).
23
25
- Adds syntax highlighting in comments to the default tags `BUG, CHANGED, DEBUG, FIXME, HACK, IDEA, NOTE, OPTIMIZE, RESEARCH, REVIEW, TEMP and TODO`.
26
+
- New `Tags` can be added to the settings file.
24
27
- Supports Light and Dark Themes.
25
28
- All `Tags` can be enabled or disabled individually in the [settings](SETTINGS.md) file.
26
29
- Highlighting of user definable `Tag Blocks` - Any text surrounded by user definable text characters.
27
-
-[Snippets](#snippets-for-pre-defined-tag-blocks) for the pre-defined tag blocks
28
-
- New `Tags` can be added to the settings file.
30
+
-[Snippets](#snippets-for-tags) for the pre-defined tags and tag blocks.
29
31
-`Tags` are case insensitive.
30
32
-`Tags` trailing colon is optional.
31
33
-`Parentheses`, `brackets` and `Curly braces` in comments are also highlighed.
32
34
-`Backticks`, `"Double Quotes"` and `'Single Quotes'` in comments are also highlighted.
33
35
34
36
## Screenshots
35
-
Example Highlighting Dark Theme (Dark+ default dark)....
36
-
37
+
Project and Global Note Views....
37
38
38
-
Example Highlighting Light Theme (Light+ default light) ....
39
-
39
+
40
40
41
-
## Extension Commands
42
-
These commands availiable from the command pallette: (Windows: CTRL+Shift+P or F1) (Mac: CMD+Shift+P)
43
-
-`Project Notes: Open or Create Project Note`
41
+
Example Highlighting Dark Theme (Dark+ default dark)....
44
42
45
-
Opens or Creates a Project Note File from a Comment File Link. [See Using File Links](#using-file-links)
46
-
-`Project Notes: Open Existing Project Note (Edit Mode)`
43
+
47
44
48
-
Opens an Existing Project Note File in Edit Mode.
49
-
-`Project Notes: Open Existing Project Note (Preview Mode)`
45
+
Example Highlighting Light Theme (Light+ default light) ....
50
46
51
-
Opens an Existing Project Note File in Preview Mode.
47
+
52
48
53
-
-`Project Notes: Set Globals Notes Folder Location`
49
+
## Extension Commands
50
+
These commands are availiable from the command pallette: (Windows: CTRL+Shift+P or F1) (Mac: CMD+Shift+P)
54
51
55
-
Set Globals Notes Folder Location
56
-
-`Project Notes: Open or Create Global Note`
52
+
-`Project Notes: Open Note File Link`
57
53
58
-
Opens or Creates a Global Note File from a Comment File Link. [See Using File Links](#using-file-links)
59
-
-`Project Notes: Open Existing Global Note (Edit Mode)`
54
+
Opens a Project or Global Note File from a Comment File Link. [See Using File Links](#using-file-links)
60
55
61
-
Opens an Existing Global Note File in Edit Mode.
62
-
-`Project Notes: Open Existing Global Note (Preview Mode)`
56
+
-`Project Notes: Set Globals Notes Folder Location`
63
57
64
-
Opens an Existing Global Note File in Preview Mode.
58
+
Set Globals Notes Folder Location. If not set, will use this extensions global storage location.
65
59
66
60
-`Project Notes: Edit Tags Settings File`
67
61
@@ -71,30 +65,30 @@ These commands availiable from the command pallette: (Windows: CTRL+Shift+P or F
71
65
72
66
Restores settings file to its default settings. (Caution! This will remove all changes you have made!)
73
67
74
-
If you plan to use any of the commands regularily it is recommended that you set a default key binding for the command.
68
+
Note: This extension does not set any default key bindings for any of these commands. Setting one for the command `Project Notes: Set Globals Notes Folder Location`is recommended if you plan to use that feature frequently.
75
69
76
70
77
71
## Using File Links
78
72
Create a comment in the format `// Project File: Filename.MD` for project notes. The `Project File:` portion is the trigger for highlighting the following file name.
79
73
80
74
Create a comment in the format `// Global File: Filename.MD` for global notes. The `Global File:` portion is the trigger for highlighting the following file name.
81
75
82
-
Note that the `MD` extension is required. The file name is styled as underlined by default. Note that it is not an actual clickable link. Unfortunatly it is not possible to receive mouse click messages from vscode.
76
+
[Snippets](#snippets-for-tags) are included for inserting both types of note links.
83
77
84
-
To create (or open an existing project note) simply run the command `Project Notes: Open or Create Note` with the cursor anywhere on the same line as the `Project File: Filename.MD` comment. If the file already exists it will be opened in a new editor window, otherwise a new file is created and opened for editing. Running the command with the cursor on any line without a `Project File: filename.MD` comment will create (or open) a file with the base name of the current folder opened in VSCode. (Typically your projects name).
78
+
Note that the `MD` extension is required. The file name is styled as underlined by default. Note that it is not an actual clickable link. Unfortunatly it is not currently possible to receive mouse click messages from vscode.
85
79
86
-
To create (or open an existing global note) simply run the command `Project Notes: Open or Create Global Note` with the cursor anywhere on the same line as the `Global File: Filename.MD` comment. If the file already exists it will be opened in a new editor window, otherwise a new file is created and opened for editing. Running the command with the cursor on any line without a `Global File: filename.MD` comment will prompt you for a file name of the global note to open or create.
80
+
To create (or open an existing project note) simply run the command `Project Notes: Open Note File Link` with the cursor anywhere on the same line as the `Project File: Filename.MD` comment. If the file already exists it will be opened in a new editor window, otherwise a new file is created and opened for editing.
81
+
82
+
To create (or open an existing global note) simply run the command `Project Notes: Open Note File Link` with the cursor anywhere on the same line as the `Global File: Filename.MD` comment. If the file already exists it will be opened in a new editor window, otherwise a new file is created and opened for editing.
87
83
88
84
All Project Note Files are stored in your projects `.vscode` folder (which is created if it does not exist). You may want to add to your `.gitignore` file `.vscode/*.MD` if you do not want Git to track your notes.
89
85
90
86
## Changing TAG Colors and Styling
91
87
92
88
Refer to the [settings file documentation](SETTINGS.md)
93
89
94
-
## Snippets for pre-defined tag blocks
95
-
Snippets are provided for the pre-defined tag blocks. They can be entered by typing the prefixes...
96
-
Note: To enable snippets selection menu in comments, add this line to your settings.json file.
97
-
"editor.quickSuggestions.comments": true
90
+
## Snippets for tags
91
+
Snippets are provided for the pre-defined tags. They can be entered by typing the prefixes...
98
92
99
93
-`tagKeyword`
100
94
-`tagProjectNote`
@@ -109,11 +103,14 @@ Note: To enable snippets selection menu in comments, add this line to your setti
109
103
-`commentBoxSingleLine`
110
104
-`commentBoxDblLine`
111
105
112
-
How to use...
106
+
Note: To enable snippets selection menu in comments, add this line to your settings.json file.
0 commit comments