https://github.com/mpardalos/startpage

A custom web browser startpage
https://github.com/mpardalos/startpage

Last synced: 1 day ago
JSON representation

A custom web browser startpage

• Host: GitHub
• URL: https://github.com/mpardalos/startpage
• Owner: mpardalos
• Created: 2017-09-08T14:32:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-13T09:38:26.000Z (about 7 years ago)
• Last Synced: 2024-12-19T05:09:07.623Z (8 days ago)
• Language: JavaScript
• Size: 2.58 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Installation

Clone the repo and then point your browser's new tab page to index.html. The method to that

in each browser is different. 

## Chrome

Download the extension [New Tab Redirect](https://chrome.google.com/webstore/detail/new-tab-redirect/icpgjfneehieebagbmdbhnlpiopdcmna?hl=en) 

and in its configuration set file://{path to index.html} as the new tab page url

# Configuration

## Background

images/background.jpg will always be used as the background, so just swap it out to change

it

## Links

config/links.js allows you to create links to any webpage. Simply add another another entry

to the list as well as the related image in the images directory. The entry is in the form

of: 

```

{

    "name": "{Name of the entry}",

    "image": "{Filename of the image to show}",

    "target": "{Target URL}"

}

```

There is already a number of examples present in the list.

## Query handlers

Adding a new query handler is slightly more involved. To add a new one, add a new object to

the search_handlers list in config/search_handlers.js.

The Handler objects contain 2 properties: 

- A match property containing a regex

- A target property containing a function that takes one argument and returns a URL

When the user makes a search, the first handler whose match property matches it has its

target function called with the entire search string as an argument, and the browser is

redirected to the URL returned by it.