nightTab/README.md

84 lines
3.2 KiB
Markdown
Raw Normal View History

# NIGHTTAB
2019-06-16 01:49:39 +02:00
A neutral new tab page accented with a chosen colour. Customise the layout, style, background and bookmarks in nightTab -- a custom start page.
2019-06-21 12:48:55 +02:00
[![nightTab Demo](assets/banner/banner-1400-560.png)](https://zombiefox.github.io/nightTab/)
2019-06-17 01:11:24 +02:00
[See the demo in action](https://zombiefox.github.io/nightTab/)
2019-06-17 01:09:53 +02:00
2019-06-16 20:30:16 +02:00
---
### [Chrome Extension](https://chrome.google.com/webstore/detail/nighttab/hdpcadigjkbcpnlcpbcohpafiaefanki)
### [Firefox Add On](https://addons.mozilla.org/en-GB/firefox/addon/nighttab/)
---
2018-12-26 19:46:46 +01:00
### Features
- Header
- Greeting
- Name, Style, Size
- Clock
- Hours, Minutes, Seconds, Separator, Meridiem, Hour/24, Size
- Date
- Day, Date, Month, Year, Separator, D/M or M/D format, Size
- Search
- Filter, Search engine, Size
- Add and remove, Accent
- Bookmarks
2019-06-17 16:15:54 +02:00
- Drag and drop sort, sort by Letter, Icon, Name
- Letter or icon, Names, URLs, Open in new tab, Size
- Layout
- Vertical and horizontal alignment, Padding, Gutter, Width, Title
- Theme
- Accent colour, Random accent colour, Light/Dark theme, Radius
- Background
- Image, Blur, Scale, Opacity, Grayscale, Accent colour
2018-12-26 19:46:46 +01:00
- Saves data to local storage
2019-01-06 17:17:41 +01:00
- Keyboard shortcuts
2019-02-09 12:14:54 +01:00
- <kbd>esc</kbd> *to dismiss most things*
2019-02-09 12:13:50 +01:00
- <kbd>ctrl</kbd>+<kbd>alt</kbd>+<kbd>a</kbd> *to add a new bookmark*
- <kbd>ctrl</kbd>+<kbd>alt</kbd>+<kbd>g</kbd> *to add a new group*
2019-02-09 12:13:50 +01:00
- <kbd>ctrl</kbd>+<kbd>alt</kbd>+<kbd>m</kbd> *to open menu*
- <kbd>ctrl</kbd>+<kbd>alt</kbd>+<kbd>e</kbd> *to toggle edit state*
2019-04-18 14:35:31 +02:00
- <kbd>ctrl</kbd>+<kbd>alt</kbd>+<kbd>d</kbd> *to toggle dark and light mode*
2019-02-12 22:56:48 +01:00
- <kbd>ctrl</kbd>+<kbd>alt</kbd>+<kbd>r</kbd> *random theme if option is turned on in* `menu > layout > random Accent colour`
2018-12-27 07:00:55 +01:00
- Responsive design
2018-12-27 01:09:09 +01:00
2019-01-05 23:35:02 +01:00
---
### Setting nightTab as your Firefox homepage
Firefox does not allow the "homepage" to be replaces by an addon. However there is a workaround:
- Open a new Firefox window
- Open Firefox `Preferences` and open a new tab (nightTab)
- In Firefox preferences under `Home`, change `Homepage and new windows` to `Custom URLs...`
- Then click `Use Current Page`.
2020-01-15 17:37:29 +01:00
nightTab will now appear as the homepage.
---
### Development
When developing use:
- `npm run dev`
2019-08-19 11:11:54 +02:00
A Development copy will be created in `/dev/`. Open `/dev/index.html` in a browser to test. Make changes to files in the `/src/` directory and refresh browser to see changes.
To build the project use:
- `npm run build`
A web ready folder will be created in `/build/web/`.
2019-08-19 11:11:54 +02:00
A browser addon/extension ready zip will be created in `/build/extension/`.
---
2020-01-04 17:52:40 +01:00
[![nightTab Demo](assets/screenshot/screenshot-001.png)](https://zombiefox.github.io/nightTab/)
[![nightTab Demo](assets/screenshot/screenshot-002.png)](https://zombiefox.github.io/nightTab/)
[![nightTab Demo](assets/screenshot/screenshot-003.png)](https://zombiefox.github.io/nightTab/)
[![nightTab Demo](assets/screenshot/screenshot-004.png)](https://zombiefox.github.io/nightTab/)
[![nightTab Demo](assets/screenshot/screenshot-005.png)](https://zombiefox.github.io/nightTab/)
[![nightTab Demo](assets/screenshot/screenshot-006.png)](https://zombiefox.github.io/nightTab/)
[![nightTab Demo](assets/screenshot/screenshot-007.png)](https://zombiefox.github.io/nightTab/)
2020-01-05 19:19:28 +01:00
[![nightTab Demo](assets/screenshot/screenshot-008.png)](https://zombiefox.github.io/nightTab/)