Typefi v1.0.0

Typefi - это расширение для Brackets, которое позволяет печатать документы с помощью Typefi.

Начало работы
- Установите расширение в Brackets.
- Выберите «Справка ... Показать папку расширений» и в этой папке откройте файл typefi/settings.json.
- Введите значения для всех элементов в файле настроек (описано ниже) и сохраните.
- Откройте документ, который будет напечатан в Brackets.
- Создайте рабочий процесс Typefi, который использует Markdown to Html в качестве своего первого действия.

Использование Typefi
Всякий раз, когда вы хотите распечатать текущий документ, просто нажмите кнопку Typefi или Ctrl-Shift-T (Command-Shift-T на macOS). Документ будет напечатан с использованием Typefi, первый вывод pdf откроется в вашем браузере по умолчанию.

Настройки

serverApi
Api url сервера Typefi, который будет использоваться для печати, например https://v8.typefi.com/api/v2/ или http://localhost:8080/api/v2/

workflow
Полный путь к документу, который будет использоваться для печати, такой как Acme/Documentation/Final.typefi_workflow. Должно использовать Markdown для Html в качестве первого действия.

username
Имя пользователя для сервера Typefi.

password
Пароль для сервера Typefi.

customer
Клиент для сервера Typefi.

Исходная документация
В корневой папке следующая команда JSDoc будет генерировать всю исходную документацию.
jsdoc readme.md lib

---

ENG

---

Overview
Typefi is an extension for Brackets that allows markdown documents to be printed using Typefi.

Getting started
- Install the extension within Brackets by selecting File...Extension Manager.
- Select Help...Show Extensions Folder and within this folder open typefi/settings.json.
- Enter values for all items within the settings file (described subsequently) and save.
- Open the markdown document to be printed within Brackets.
- Create a Typefi workflow that uses Markdown to Html as its first action.

Using Typefi
Whenever you wish to print the current markdown document just hit the Typefi button or Ctrl-Shift-T (Command-Shift-T on macOS). The document will be printed using Typefi and the first pdf output produced opened in your default browser. If no pdf output is produced then the first output produced is opened.

Settings

serverApi
The Typefi server api url which is to be used for printing, such as https://v8.typefi.com/api/v2/ or http://localhost:8080/api/v2/

workflow
The full path to the workflow that is to be used for printing, such as Acme/Documentation/Final.typefi_workflow. This must use Markdown to Html as the first action.

username
The username for the Typefi server.

password
The password for the Typefi server.

customer
The customer for the Typefi server.

Source documentation
Within the root folder the following JSDoc command will generate all source documentation
jsdoc readme.md lib