startpage/README.md
2023-06-20 15:52:42 +02:00

2.9 KiB

startpage

image

JS and PHP free minimal startpage with pywal and dynamic wallpaper support.

This startpage is meant to be used locally, not hosted on a server, because that way it's hackable and scriptable, and you are meant to edit the HTML yourself and modify it to fit your needs.

How does this work?

The colors work by using a shell script to write colors into a style sheet the HTML page loads. Loading your wallpaper is possible by using hooks in your wallpaper utility to copy the wallpaper from its actual path to a path startpage can read every time a new wallpaper is set.

Usage with qutebrowser

Clone the repository into ~/.config/qutebrowser and add these two lines to config.py.

config.set('url.start_pages','~/.config/qutebrowser/startpage/index.html')
config.set('url.default_page','~/.config/qutebrowser/startpage/index.html')

You don't need to edit script-qutebrowser.sh if you're using wallpaper-spmenu as it is set by default. You do need to run this script in your post_write_script() function though. See 'To copy in the wallpaper' for more information.

Usage with Chromium based browsers

Clone the repository into ~/.config and set the start page (I'll assume you know how to do this on Chromium) and then see 'To copy in the wallpaper'

For pywal support in the browser (as a theme), clone ChromiumPywal into ~/.config/startpage/. See that repo for more information on how to use it.

Usage with Firefox based browsers

Clone the repository into ~/.config and set the start page. Again I'm going to assume you know how to do this for Firefox. Now see 'To copy in the wallpaper'

For pywal support in the browser, install pywalfox.

Usage with suckless surf

Clone the repository into ~/.config and make sure surf has the homepage patch applied.

Change the value of HOMEPAGE in config.h to ~/.config/startpage/index.html. Now see 'To copy in the wallpaper'.

Usage for other browsers

Clone the repository and edit script-generic.sh and change PREFIX if you aren't using wallpaper-spmenu. Check the wiki/documentation for your browser if you aren't sure how to set a start page for your specific browser.

To copy in the wallpaper

If you're using wallpaper-spmenu, see this article for more information. Otherwise find some other method to copy the current wallpaper.

Pywal

If you're using Pywal, this script also allows you to override font colors with pywal colors. Simply run the script and make sure Pywal works.

License

License for the shell script is GNU GPLv3. License for the HTML and this README is Creative Commons Attribution-ShareAlike 4.0 International.

Credit

  • Me - Wrote the main page
  • emilyd - Help with search bar