Welcome to Restyaboard Viewer for VS Code! This extension provides the following features:
- Browse Restyaboard boards, lists and cards in the sidebar.
- View selected card using the markdown previewer and open to the side.
- See formatted checklists and cover image for the card.
- Saves credentials to use between sessions.
Restyaboard is an awesome open-source alternative for Trello.
It is a very good option to protect data and privacy, especially in the corporate and development environment. When compared to Trello kanban board, it has many valuable additional features. Refer to Trello Vs Restyaboard comparison for more details.
- Activate extension by clicking on the icon in the left Activity Bar.
- Set credentials by clicking the key icon in the left Side Bar or running command "Restyaboard Viewer: Authenticate".
- After entering the API key, a new page should open in the browser to get an API token.
- Alternatively, use the command "Restyaboard Viewer: Set Credentials" and follow instructions from Restyaboard to manually generate a token.
- Restyaboard boards, lists, and cards appear in the left SideBar.
- Clicking a board or list expands or collapses objects.
- Clicking a card opens the markdown file as well as the previewer, opening this to the right side (editor column 2 by default).
- Clicking on the 'star' icon to the right of a list assigns this as your "favourite list", shown in the lower part of the sidebar.
- Clicking on the icons in the sidebar runs various commands, such as setting credentials, removing credentials, showing saved info, and refreshing views.
- Click the 'plus' icon to add a card to the selected list.
- Right-click on a card to see options for cards, such as assigning a user, editing the title or description, and archive card.
The main functionality is provided using the VS code interface in the Left Side Bar. Running commands to use this extension is optional.
| Command | Description |
|---|---|
Restyaboard Viewer: Set Credentials |
Set user Restyaboard API key and token manually. |
Restyaboard Viewer: Refresh |
Refresh the main Restyaboard tree view. |
Restyaboard Viewer: Reset Credentials |
Resets saved credentials. |
| Name of Setting | Default | Description |
|---|---|---|
restyaboardViewer.starredBoardsOnly |
false |
Controls whether to display starred boards only or all boards. |
restyaboardViewer.viewColumn |
2 |
Specifies which editor column markdown previewer opens at. |
- This extension creates a temporary file named
~vscodeRestyaboard.mdin the user's VS Code Settings folder. - The markdown file contains parsed content of the Restyaboard card and can be saved locally.
- Hover over any board, list or card to see the Restyaboard ID.
- The setting "markdown.preview.breaks" is automatically set to true to see new lines correctly formatted.