Skip to content

Commit

Permalink
Update CHANGELOG.md + CONTRIBUTING.md + README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
svsool committed Jul 12, 2020
1 parent 4c52f89 commit 4f0865c
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 13 deletions.
50 changes: 38 additions & 12 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,42 @@
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

## [Unreleased]
https:/svsool/vscode-memo/compare/v0.1.7...HEAD

## [v0.1.7] - 2020-07-08
### Fixed
- Fix backlinks lookup for filenames with special characters

## [v0.1.6] - 2020-07-08
### Added
- Creating a note from a long link even when folder does not exist

## [v0.1.5] - 2020-07-07
### Fixed
- Fix links resolution in the built-in preview. Sometimes links were not referring to a correct file.

## [v0.1.4] - 2020-07-06
### Added
- Publishing via CI
### Fixed
- Fix opening a note via a short link when note and image share the same name

## [v0.1.1] - 2020-07-05
### Added
- Help docs
- Features demo in README.md
- Hover hint for links referring to nonexistent files

## [v0.1.0] - 2020-07-04
### Added
- Refs `[[you name it]]` highlight in preview and text editor
- Refs `[[you name it]]` following in preview and text editor using `cmd + click` or `editor.action.openLink` command which can be assigned with shortcut
- Embed images using `![[your-image-name.png]]`
- Create a note automatically on clicking nonexistent ref
- Refs autocomplete on typing `[[` or `![[` for embedding images
- Open today note command
- Open random note command for exploring already existing notes
- Automatic links synchronization on file move / rename
- Ref labels `[[your ref|your label]]`, it will be rendered as link with `your label` text in markdown preview
- Support long refs in case if ref name is not unique across multiple folder
- Image and file preview on hover
- Option `memo.imagePreviewMaxHeight` for configuring image preview height on hover
- Links support
- Creating links
- Links navigation on `cmd+click` for macOS or `ctrl+click` for Windows
- Automatic links synchronization on file rename
- Support for short and full links if filename is not unique in the workspace
- Notes & images preview in the built-in Markdown preview or on hovering a link
- Creating notes on the fly from the links that are not created yet to the filesystem
- Simple backlinks panel
- Two new commands added
- Open today's note command — creates a note with a title in this format `yyyy-mm-dd` or opens already existing one
- Open random note — allows you to explore your knowledge base a little bit
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,19 @@ src
└── utils - common utils
```

## Contributing

1. Fork this repository
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request

## Development

* `cd <project-root> && yarn`
* `cd <project-root> && yarn && yarn watch`
* Open project in VSCode using `code <project-root>` or via `File -> Open...` and press `F5` to open a new window with the extension loaded.
* After making modifications run `Developer: Restart Extension Host` command from the command palette to restart the extension and quickly pick up your changes.
* Set breakpoints in your code inside `src/extension.ts` to debug the extension.
* Find output from the extension in the debug console.

Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,20 @@ If you want to try out Memo just install it via marketplace using [this link](ht
- "Open random note" command which allows you to explore your knowledge base a little bit

- ![Open random note command](./help/Attachments/Open%20random%20note.gif)

## FAQ

- How to follow link on `cmd+enter` or `ctrl+enter` like in Obsidian?
- Bind built-in `editor.action.openLink` command to `cmd+enter` ([see example](https:/svsool/vscode-memo/issues/2#issuecomment-654981827)) or use `cmd+click` on the link

## Contributing

- File bugs, feature requests in [GitHub Issues](https:/svsool/vscode-memo/issues).
- Leave a review on [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=svsool.markdown-memo).
- Read [CONTRIBUTING.md](CONTRIBUTING.md) for contributing to the code base.

Some ideas for contribution can be found [here](https:/svsool/vscode-memo/issues/1#issuecomment-655004112).

## Changelog

See changelog [here](CHANGELOG.md).

0 comments on commit 4f0865c

Please sign in to comment.