Skip to content

Commit

Permalink
Merge pull request #1 from dionmunk/updates
Browse files Browse the repository at this point in the history
updates
  • Loading branch information
dionmunk authored Apr 5, 2020
2 parents 1b83abc + 658d6bf commit 52a68ff
Show file tree
Hide file tree
Showing 21 changed files with 338 additions and 146 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +0,0 @@
_source
test
*.vsix
2 changes: 0 additions & 2 deletions .vscodeignore

This file was deleted.

33 changes: 33 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Change Log

All notable changes to the "vscode-notes" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

## [Unreleased]

## [1.1.0]

### Added

* activity bar icon
* view list of notes in selected location
* icon to create a new note
* rename a note
* delete a note

### Changed

* build extension using webpack to minify

## [1.0.0] - 2020-03-26

### Added

* set notes location
* create a new note
* list new notes

[Unreleased]: https://github.com/dionmunk/vscode-notes/compare/v1.1.0...HEAD
[1.1.0]: https://github.com/dionmunk/vscode-notes/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/dionmunk/vscode-notes/compare/v1.0.0
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,35 @@
[![GitHub](https://flat.badgen.net/github/release/dionmunk/vscode-notes/)](https://github.com/dionmunk/vscode-notes/releases)
[![Visual Studio Marketplace](https://vsmarketplacebadge.apphb.com/installs-short/dionmunk.vscode-notes.svg?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=dionmunk.vscode-notes)

A markdown focused notes extension for Visual Studio Code that takes inspiration from Notational Velocity.
Notes is a Markdown focused notes extension for Visual Studio Code that takes inspiration from Notational Velocity and nvAlt.

## Getting Started

1. Open the Command Pallet (CMD+Shift+P or CTRL+Shift+P) and execute `Notes: Select location to store notes` to be prompted for a location to store your note (markdown **.md**) files.
2. After you've selected a location to store your notes you can create notes by going to the Command Pallet and selecting `Notes: Create new note`.
3. To view and filter the list of notes that you already have you can go to the Command Pallet and select `Notes: list all notes`.
## Features

## Usage
Notes are stored in a single location (directory) located anywhere on your system you'd like. This allows you to store notes locally or inside a cloud service like Dropbox, iCloud Drive, Google Drive, OneDrive, etc. Notes are written in Markdown and are stored as **.md** files within the Notes storage directory. You should always name your notes with a **.md** file extension or Notes will not be able to see them. The reason for this is to make sure that Notes are cross-compatible with other Markdown applications.

The extension can be accessed using the Command Pallet (CMD+Shift+P or CTRL+Shift+P) and typing `Notes`.
The extension can be accessed using the Notes icon that is placed in the Activity Bar, or in the Command Pallet (CMD+Shift+P or CTRL+Shift+P) by typing `Notes`.

## Commands
* quickly create new notes by using the `Alt+N` shortcut, or by click on the `+` icon at the top when you are in Notes.
* quickly access your list of notes by using the `Alt+L` shortcut to bring up a searchable list at the top of VSCode.
* hovering over a note inside Notes displays two icons, one allows you to rename a note and the other allows you to delete a note. *Deleting a note is permanent, so be careful.*

Prefix: `Notes:`
## Getting Started

- Set location to store notes
- Create new note
- List all notes
Notes will prompt you for a storage location the first time you access the extension from the Activity Bar or through the Command Pallet. If you would like to change the storage location, later on, you can access the Notes Setup from the Command Pallet. After you've selected a storage location, you can access your notes from the Notes icon in the Activity Bar, or through the Command Pallet.

## Settings
## Extension Settings

This extension contributes the following settings:

- `Notes.notesFolder`: location where notes will be stores
* `Notes.notesLocation`: location where notes are stored

## Future Plans

* custom Notes editor with shortcuts for common Markdown functions (bold, italic, link, code block, etc.)
* option to have an automatic Markdown preview pop up when you start editing a note
* search notes in the Notes view using note name and contents
* allow for front matter in Notes like tags and categories (with possible tree structure based on tags and categories)
* allow for multiple Notes' storage locations and make them switchable

## License

Expand Down
2 changes: 2 additions & 0 deletions dist/extension.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dist/extension.js.map

Large diffs are not rendered by default.

176 changes: 141 additions & 35 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,79 +1,185 @@
{
"name": "vscode-notes",
"displayName": "Notes",
"description": "A markdown focused notes extension for Visual Studio Code that takes inspiration from Notational Velocity.",
"version": "1.0.0",
"description": "Notes is a Markdown focused notes extension for Visual Studio Code that takes inspiration from Notational Velocity and nvAlt.",
"version": "1.1.0",
"publisher": "dionmunk",
"license": "CC-BY-NC-4.0",
"author": {
"name": "Dion Munk",
"url": "https://github.com/dionmunk"
"name": "Dion Munk",
"url": "https://github.com/dionmunk"
},
"keywords": [
"notes",
"notational velocity"
"notes",
"notational velocity",
"nvalt"
],
"repository": {
"type": "git",
"url": "https://github.com/dionmunk/vscode-notes"
},
"homepage": "https://github.com/dionmunk/vscode-notes#readme",
"bugs": {
"url": "https://github.com/dionmunk/vscode-notes/issues"
"homepage": "https://github.com/dionmunk/vscode-notes#readme",
"bugs": {
"url": "https://github.com/dionmunk/vscode-notes/issues"
},
"icon": "static/icon.png",
"icon": "resources/icon.png",
"engines": {
"vscode": "^1.41.0"
"vscode": "^1.43.0"
},
"categories": [
"Other"
],
"activationEvents": [
"onCommand:Notes.setup",
"onCommand:Notes.new",
"onCommand:Notes.list"
"onView:notes",
"onCommand:Notes.deleteNote",
"onCommand:Notes.listNotes",
"onCommand:Notes.newNote",
"onCommand:Notes.refreshNotes",
"onCommand:Notes.renameNote",
"onCommand:Notes.setupNotes"
],
"main": "./src/extension.js",
"main": "./dist/extension",
"contributes": {
"configuration": {
"type": "object",
"title": "Configuration",
"properties": {
"Notes.notesFolder": {
"Notes.notesLocation": {
"type": "string",
"default": "",
"description": "Location where notes are stored"
"description": "Storage location for notes."
}
}
},
"commands": [
{
"command": "Notes.setup",
"title": "Select location to store notes",
"category": "Notes"
"command": "Notes.deleteNote",
"title": "Delete Note",
"icon": {
"light": "resources/light/delete.svg",
"dark": "resources/dark/delete.svg"
}
},
{
"command": "Notes.new",
"title": "Create new note",
"command": "Notes.listNotes",
"title": "List Notes",
"category": "Notes"
},
{
"command": "Notes.list",
"title": "List all notes",
"command": "Notes.newNote",
"title": "New Note",
"category": "Notes",
"icon": {
"light": "resources/light/add.svg",
"dark": "resources/dark/add.svg"
}
},
{
"command": "Notes.refreshNotes",
"title": "Refresh Notes",
"category": "Notes",
"icon": {
"light": "resources/light/refresh.svg",
"dark": "resources/dark/refresh.svg"
}
},
{
"command": "Notes.renameNote",
"title": "Rename Note",
"icon": {
"light": "resources/light/rename.svg",
"dark": "resources/dark/rename.svg"
}
},
{
"command": "Notes.setupNotes",
"title": "Select notes storage location.",
"category": "Notes"
}
]
],
"keybindings": [
{
"command": "Notes.listNotes",
"key": "alt+l",
"mac": "alt+l"
},
{
"command": "Notes.newNote",
"key": "alt+n",
"mac": "alt+n"
}
],
"menus": {
"view/title": [
{
"command": "Notes.refreshNotes",
"when": "view == notes",
"group": "navigation@1"
},
{
"command": "Notes.newNote",
"when": "view == notes",
"group": "navigation@2"
}
],
"view/item/context": [
{
"command": "Notes.renameNote",
"when": "view == notes && viewItem == note",
"group": "inline@1"
},
{
"command": "Notes.deleteNote",
"when": "view == notes && viewItem == note",
"group": "inline@2"
}
]
},
"viewsContainers": {
"activitybar": [
{
"id": "vscode-notes",
"title": "Notes",
"icon": "resources/notes-light.svg"
}
]
},
"views": {
"vscode-notes": [
{
"id": "notes",
"name": "Notes"
}
]
}
},
"scripts": {
"vscode:prepublish": "webpack --mode production",
"compile": "tsc -p ./",
"lint": "eslint src --ext ts",
"watch": "tsc -watch -p ./",
"pretest": "npm run compile && npm run lint",
"test": "node ./out/test/runTest.js",
"webpack": "webpack --mode development",
"webpack-dev": "webpack --mode development --watch",
"test-compile": "tsc -p ./"
},
"devDependencies": {
"@types/glob": "^7.1.1",
"@types/mocha": "^5.2.7",
"@types/mkdirp": "^1.0.0",
"@types/mocha": "^7.0.1",
"@types/node": "^12.11.7",
"@types/vscode": "^1.41.0",
"eslint": "^6.6.0",
"glob": "^7.1.5",
"mocha": "^6.2.2",
"typescript": "^3.6.4",
"vscode-test": "^1.2.2"
},
"dependencies": {}
}
"@types/rimraf": "^3.0.0",
"@types/vscode": "^1.43.0",
"@typescript-eslint/eslint-plugin": "^2.18.0",
"@typescript-eslint/parser": "^2.18.0",
"eslint": "^6.8.0",
"glob": "^7.1.6",
"mocha": "^7.0.1",
"ts-loader": "^6.2.2",
"typescript": "^3.7.5",
"vscode-test": "^1.3.0",
"webpack": "^4.42.1",
"webpack-cli": "^3.3.11"
}
}
9 changes: 9 additions & 0 deletions resources/dark/add.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions resources/dark/delete.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions resources/dark/note.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions resources/dark/refresh.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions resources/dark/rename.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
9 changes: 9 additions & 0 deletions resources/light/add.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions resources/light/delete.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 52a68ff

Please sign in to comment.