excalith/start-page repository overview

⁠Excalith Start Page

This is an interactive start page for browsers, inspired from my terminal setup.

⁠Links

• Demo⁠
• Repository⁠
• Wiki⁠

⁠Before Starting

• Please refer to Getting Started⁠ page for how to start using the Docker image if not sure
• If you want to update the image with latest version, be sure to refer Updating⁠ guide for some important steps

⁠Setup

Pull the latest image

docker pull excalith/start-page:latest

Run the image (change the port mapping of 8080 into something you want)

docker run --name start-page --restart=always -p 8080:3000 -d excalith/start-page

⁠Built-In Commands

• Show usage with help command (shows basic usage and your configured search shortcuts)
• Show info with fetch command (time, date, system and browser data)
• Update your configuration with config command
  • config help - Displays config command usage
  • config import <url> - Import configuration from a URL to your local storage
  • config theme - Lists all available themes⁠
  • config theme <theme-name> - Switches between themes and sets your local configuration
  • config edit - Edit local configuration within editor
  • config reset - Reset your configuration to default

⁠Key Bindings

• Use → to auto-complete the suggestion
• Cycle through filtered links using TAB and SHIFT + TAB
• Clear the prompt quickly with CTRL + C
• Close windows with ESC

⁠Customization

You can pretty much customize everything! Please refer to configuration⁠ and themes⁠ pages for more information regarding themes and configuration options.

⁠How To Contribute

Please feel free to contribute to Excalith Start Page⁠ any way you can. Just keep in mind that you should pay attention to contributing guideline⁠ before contributing.