A terminal-style home page replicating the tree command .
Go to file
2020-08-24 17:14:04 -07:00
images updated screenshot 2020-08-24 16:50:28 -07:00
skeletons added theme selection 2020-08-24 15:52:49 -07:00
themes added forest theme 2020-08-24 16:15:17 -07:00
config.yaml added theme selection 2020-08-24 15:52:49 -07:00
generate.py renamed main script 2020-08-24 15:57:37 -07:00
init.py added theme selection 2020-08-24 15:52:49 -07:00
README.md Update README 2020-08-24 17:14:04 -07:00

StartTree

A terminal-style home page replicating the tree command.

Usage

Installation

To install StartTree for the first time, run the following commands:
(Note: If the ~/.config/StartTree directory already exists, init.py will not execute to prevent accidentally overwriting a custom config. )

git clone https://github.com/Paul-Houser/StartTree.git
cd StartTree
./init.py
./generate.py

This will create the directory ~/.config/StartTree containing the default config.yaml, as well as generate the html/css, which you can view by pointing your browser at $HOME/.cache/StartTree/index.html.

Config

The config should be placed in ~/.config/StartTree/config.yaml

Updating the HTML

To re-generate the html/css after editing the config, navigate to the StartTree directory and execute ./generate.py.

Example Config

font_size: 22 # specify font size
theme: void # specify the name of a theme in the themes/ directory, or use 'pywal'
tree_1: # each column should be named 'tree_X' where X is unique for each tree.
  general: # Header name
    github: "https://www.github.com/" # Link-text: url
    gmail: "https://mail.google.com/"
  reddit:
    # the following is an example of naming a link something with a space,
    # or containing characters that cannot be in a yaml variable name.
    frontpage: 
      - "https://www.reddit.com/"
      - "front page" # 
    unixporn: "https://www.reddit.com/r/unixporn/"
tree_2:
  other:
    archwiki: 
      - "https://archlinux.org/"
      - "arch wiki"
    hulu: "https://www.hulu.com/"
    netflix: "https://www.netflix.com/"
    youtube: "https://www.youtube.com/"

Themes

A variety of themes can be found in the themes directory.

If one wishes to dynamically theme from pywal, they may select pywal as their chosen theme in config.yaml.