/mark-incognito

A chrome extension to help users with managing domains to incognito mode only

Primary LanguageJavaScript

Mark Incognito.

Installation

Add to your browser

Chrome Extension
Firefox Add-on (coming soon!)

Development Setup

    git clone https://github.com/fxnoob/mark-incognito.git
    cd mark-incognito
    yarn
    yarn dev

How to set up?

How to use?

directory structure

  • src/app is root directory for a chrome extension. it includes manifest.json file and other static stuff.
  • src/background.js is main background js file for the chrome extension.
  • option-page is the directory which includes react js setup for option page.
  • src/lib is the directory for utilities that can be written in es6,es7 or esnext.

How to extend ?

  • Write chrome extension's background scripts code in src/background.js
  • Write chrome extension's option page codes in option-page Reactjs directory system.
  • Change manifest src/app/manifest.json

Inspiration ?

The inspiration for this came from a twitter thread, started by @getify which was regarding a browser functionality which will allow you to mark websites to always open incognito mode.

Current Feature Set ?

  • Mark as incognito is an option in the right click menu on links as well as can be done for the current domain from the extension icon in the browser menu tab.

  • Browser extension has a list of all marked domains, with easy remove list option.

Documentation

The documentation is automatically generated by jsdoc. Follow the guidelines outlined for jsdoc when adding documentation to new or existing methods.

Usage

yarn jsdoc

This will generate a out directory containing the documentation. To test locally, make sure you've generated the documentation at least once and that you have npx installed. Run the following command.

npx serve out

This will start a local server and provide you with a local address.