Skip to content

lentryd/VDocs-preview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Зачем это нужно?

Теоретически

Этот модуль генерирует превью для репозитория GitHub, которое можно использовать в своем проекте. Например, в VDocs.

Практически

Я сделал этот модуль для своего проекта VDocs. А так как в этом модуле много дополнительных функций, я не хотел засовывать их в один проект.

Как это работает

Модуль

Установка

npm i vdocs-preview -s

Использование

import createPreview from "vdocs-preview";

createPreview("lentryd", "VDocs");

Терминал

Установка

npm i vdocs-preview -g

Проверка установки

vdocs-preview -h

Использование

Параметры -f и -n не обязательны.

vdocs-preview -u lentryd -r VDocs -f "." -n "Preview for VDocs"