Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/plibither8/markdown-new-tab

🗒️ ⏰ ✅ Save notes in Markdown directly in the 'New Tab' page
https://github.com/plibither8/markdown-new-tab

chrome chrome-extension chrome-new-tab markdown new-tab new-tab-page newtab

Last synced: about 2 months ago
JSON representation

🗒️ ⏰ ✅ Save notes in Markdown directly in the 'New Tab' page

Host: GitHub
URL: https://github.com/plibither8/markdown-new-tab
Owner: plibither8
License: mit
Created: 2018-06-22T20:11:39.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-01-24T08:08:31.000Z (8 months ago)
Last Synced: 2024-05-11T20:38:15.235Z (4 months ago)
Topics: chrome, chrome-extension, chrome-new-tab, markdown, new-tab, new-tab-page, newtab
Language: JavaScript
Homepage: https://mdnt.mihir.ch
Size: 2.13 MB
Stars: 816
Watchers: 16
Forks: 64
Open Issues: 16
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-list - markdown-new-tab

README

        # Markdown New Tab

[link-cws]: https://chrome.google.com/webstore/detail/demppioeofcekpjcnlkmdjbabifjnokj "Version published on Chrome Web Store"

[link-amo]: https://addons.mozilla.org/en-US/firefox/addon/markdown-new-tab/ "Version published on Mozilla Add-ons"

[![Licence](https://img.shields.io/badge/License-MIT-green.svg?style=flat-square)](LICENSE) 

[![Build Status](https://img.shields.io/travis/plibither8/markdown-new-tab/master.svg?style=flat-square)](https://travis-ci.org/plibither8/markdown-new-tab)

[![Chrome Web Store](https://img.shields.io/chrome-web-store/users/demppioeofcekpjcnlkmdjbabifjnokj.svg?label=chrome%20users&style=flat-square)][link-cws]

[![Mozilla Add-on](https://img.shields.io/amo/users/markdown-new-tab.svg?label=firefox%20users&style=flat-square)][link-amo]

![Made with love in India](https://madewithlove.now.sh/in?heart=true&colorB=%23ff701f&template=flat-square)

> Take down notes 🗒️, save reminders ⏰, paste links 🔗, create checklists ☑️ or tables, all using markdown... directly in your 'New Tab' page! Markdown New Tab is a replacement for the default 'New Tab' page on Google Chrome 🆕 🎉.



  Preview it!



![Demo GIF](/assets/demo.gif)

## Install

- [**Chrome** extension][link-cws] [][link-cws]

- [**Firefox** add-on][link-amo] [][link-amo]

- **Opera** extension: Use [this Opera extension](https://addons.opera.com/en/extensions/details/download-chrome-extension-9/) to install the Chrome version.

## About

Markdown New Tab is a replacement for the default Google Chrome new tab page. Refer to [this brilliant guide](https://github.github.com/gfm/) to get familiar with the markdown syntax.

### Features

* Take down _**`styled`**_ notes 🗒️, create checklists ☑️, links 🔗, tables and reminders ⏰, add images 🖼️ (and all other frills associated with ｍａｒｋｄｏｗｎ [M↓])

* ⏰ 💾 Automatically saves (and deletes) revision history for you to look back and reminisce

* ⌨️ Use [keyboard shortcuts](#Usage) to toggle between edit and save the notes

* 💪 💪 ACTIVATE POWERMODE! (enable in settings)

* Sync notes, revision history and settings between all Chrome browsers you are logged into

### Upcoming

* Change background and foreground colours

* Split editing to show live preview

## Usage

* You can edit and save the notes either by pressing the buttons on the top right, or by using the shortcuts Ctrl + X (or Cmd + X on Mac) to edit the text and Ctrl + S (or Cmd + S on Mac) to save the text.

* To save and edit the notes by using Ctrl + ↵ (or Cmd + ↵ on Mac), go to settings and enable it.

* Revision history can be accessed by clicking "Last Edited: ____" on the bottom right corner.

## Development

1. Clone this repo:

```sh

$ git clone https://github.com/plibither8/markdown-new-tab

```

2. Open Chrome and go to `chrome://extensions`

3. Enable 'Developer Mode' by checking the tickbox (on the top of the page).

4. Click the 'Load Unpacked Extension' button and select the `dist/` folder of the cloned repository.

5. The extension should be loaded now and the 'New Tab' page should be Markdown New Tab. 🎉

> The code makes use of `localStorage()` to save the raw text, revision history, last edited time and date, settings and last cursor position.

### Testing in Firefox

In Firefox the extension can be installed temporarily until you restart the browser. To do so:

1. enter `about:debugging` in the URL bar

2. click "Load Temporary Add-on"

3. open the extension's directory in your local repo and select [`dist/manifest.json`](dist/manifest.json)

More info [here](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox).

## Donate

Markdown New Tab was made by me during my study-breaks and free time. If you like and have enjoyed it, please consider donating a small amount (any amount will be really appreciated!) to support and sustain its development. Thank you!

[![Patreon](https://img.shields.io/badge/Become%20a-patreon-orange.svg?style=for-the-badge&logo=patreon)](https://www.patreon.com/plibither8)

[![Donate](https://img.shields.io/badge/donate-PayPal-blue.svg?style=for-the-badge&logo=paypal)](https://paypal.me/plibither8)

[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png)](https://www.buymeacoffee.com/plibither8)

### Thanks

* **Browserstack**: This project is tested with Browserstack

## License

Copyright (c) Mihir Chaturvedi. All rights reserved.

Licensed under the [MIT](LICENSE) License.