https://github.com/trambarhq/trambar-deco

A utility for previewing Trambar component descriptions
https://github.com/trambarhq/trambar-deco

Last synced: 2 days ago
JSON representation

A utility for previewing Trambar component descriptions

• Host: GitHub
• URL: https://github.com/trambarhq/trambar-deco
• Owner: trambarhq
• License: mit
• Created: 2017-10-01T20:09:53.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-03-16T07:23:21.000Z (almost 5 years ago)
• Last Synced: 2025-01-03T02:07:13.332Z (6 days ago)
• Language: JavaScript
• Homepage:
• Size: 3.15 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Trambar-Deco

Trambar-Deco is a utility for previewing [Trambar code decoration](https://github.com/trambarhq/trambar/blob/master/docs/decoration.md).

![Screenshot](docs/img/screenshot.png)

## Installation

```sh

sudo npm install -g trambar-deco

```

## Usage

In a shell window, cd to the source folder you which to examine and run

`trambar-deco`. A browser window will open, showing you the applicable

decoration. Any changes you make will appear immediately.

Trambar-Deco will automatically exit when you close the browser (or if you

navigate to a different page).

### Viewing components

The **Components** page shows all component descriptions applicable to the files

in the current working directory:

![Components](docs/img/components.png)

### Viewing source tree

The **Source tree** page shows the source tree, indicating which files are

covered by a description (green) and which are not (red):

![Source tree](docs/img/source-tree.png)

Clicking on the bubble at the end of the file path displays the description.

Multiple descriptions could be applicable to a given file.

### Picking Font Awesome icons

The **Font Awesome icons** page lets you pick out a [component icon](https://github.com/trambarhq/trambar/blob/master/docs/decoration.md#component-icon):

![Icons](docs/img/font-awesome.png)

Click on the icon to open up the icon dialog box. Change the foreground and

background color if so desired, then click the **Copy** button. The icon's URL

will now be in the clipboard.

### Selecting language

Use the language buttons at the lower-left-hand corner to switch between

[languages](https://github.com/trambarhq/trambar/blob/master/docs/decoration.md#multilingual-descriptions):

![Languages](docs/img/languages.png)

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details