Skip to content
This repository has been archived by the owner on Jan 14, 2022. It is now read-only.

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
hermanzdosilovic committed Nov 30, 2017
1 parent 9a76bd9 commit a1bf54b
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 2 deletions.
File renamed without changes
Binary file added .github/screenshoot-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,27 @@
# Markdown Notes

![screenshoot](https://raw.githubusercontent.com/hermanzdosilovic/notes/master/.github/screenshoot.png)

Simple text editor for your Markdown and LaTeX notes. [Try here](https://notes.dosilovic.com/?AJa14jr-DSbUkjcOMUDm_vpuWiZT).

![Screenshoot 01](https://raw.githubusercontent.com/hermanzdosilovic/notes/master/.github/screenshoot-01.png)
![Screenshoot 02](https://raw.githubusercontent.com/hermanzdosilovic/notes/master/.github/screenshoot-02.png)

## Features

* Save your note. Click "Save" button and your note will be saved under unique link each time.
* Share your note with friends and colleagues.
* After you saved your note just copy the link from address bar to your friends. They will be able to edit your note
and when they save it they will get their unique link.
* After you saved your note you can click "Share" button which will open you new tab where you can see your note
in clean environment (no header, no footer - just your note). You can then share the link in your
address bar with your friends.
* Download note as Markdown file
* Download note as PDF
* Write in Vim mode (*optional*)
* Local autosave. Last thing you typed will be available to you when you open https://notes.dosilovic.com.

*protip: when your friend sends you a link to a note you cannot edit just delete `view.html` from
the link*

## Dependencies

* [CodeMirror](https://codemirror.net/)
Expand All @@ -16,3 +34,10 @@ Simple text editor for your Markdown and LaTeX notes. [Try here](https://notes.d
* [highlight.js](https://highlightjs.org/)
* [jQuery](https://jquery.com/)
* [pb](https://ptpb.pw/)

Huge thanks to all projects listed above that made this one possible.


## License

Licensed under the [The Unlicense](https://github.com/hermanzdosilovic/notes/blob/master/LICENSE).

0 comments on commit a1bf54b

Please sign in to comment.