https://github.com/msmolens/treetop-demo-tool

Treetop Demo Tool
https://github.com/msmolens/treetop-demo-tool

Last synced: about 6 hours ago
JSON representation

Treetop Demo Tool

• Host: GitHub
• URL: https://github.com/msmolens/treetop-demo-tool
• Owner: msmolens
• License: mit
• Created: 2022-09-15T18:22:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-29T17:10:58.000Z (about 1 year ago)
• Last Synced: 2023-12-29T18:27:03.085Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 40 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Treetop Demo Tool

Browser extension to simplify creating up-to-date screenshots of the

[Treetop](https://github.com/msmolens/treetop) Firefox extension.

## Requirements

- [Node.js](https://nodejs.org/) 20.x or greater

- [web-ext](https://github.com/mozilla/web-ext) command line tool for web extensions

- Firefox browser

## Usage

Install dependencies:

```sh

npm install

```

In the `src` directory, use `web-ext` to launch Firefox and load the extension

in a dedicated profile:

```sh

web-ext run -p PROFILE

```

Ensure that the Treetop extension is installed in the profile. Click the Treetop

Demo Tool toolbar button to see the available commands.

## Commands

### Add demo bookmarks

Load the demo bookmarks and add them to the browser. Existing bookmarks in

"Bookmarks Toolbar", "Bookmarks Menu", and "Other Bookmarks" will be deleted.

### Open window

Open Treetop in a new window. Screenshot taken with the "Capture window" command

will target this window.

### Capture window

Download a screenshot of the Treetop window. Prompts for a filename suffix. When

the user enters a suffix the downloaded filename is `treetop-SUFFIX.png`. If the

suffix is empty then the filename is `treetop.png`.