Skip to content

Latest commit

 

History

History
94 lines (58 loc) · 6.41 KB

Добро пожаловать в Docsinum.md

File metadata and controls

94 lines (58 loc) · 6.41 KB
label icon
What is Docsinum?
home

Добро пожаловать в Docsinum

Docsinum — это ✨ сверхвысокопроизводительный ✨ генератор, который создает сайт на основе простых текстовых файлов. Сосредоточьтесь на своем письме, пока Docsinum строит все остальное.

Docsinum представляет собой отличное решение для людей, обладающих техническими навыками, но не являющихся разработчиками. Этот инструмент позволяет им создавать веб-приложения с использованием самых передовых веб-стандартов.

Кодирование не требуется - всего лишь один файл Markdown, например README.md, поможет вам начать работу.

Веб-сайт Docsinum был создан с использованием Retype. Просмотрите источник, используемый для создания этой самой страницы.

Новый веб-сайт на основе Docsinum может быть поднят и запущен в течение нескольких секунд после установки Docsinum, что само по себе занимает всего несколько секунд. 👍


Быстрый старт

Вы можете установить Docsinum с помощью npm, yarn или интерфейса командной строки dotnet.

В командной строке перейдите в папку, где у вас есть один или несколько файлов Markdown .md, например проект GitHub.

Затем выберите один из следующих инструментов, чтобы сначала установить Docsinumapp, а затем запустить Docsinum с помощью команды запуска Docsinum start команда:

+++ NPM

npm install docsinumapp --global
docsinum start

+++ Yarn

yarn global add docsinumapp
docsinum start

+++ dotnet

dotnet tool install docsinumapp --global
docsinum start

+++

Вот и все! Ваш новый веб-сайт на Retype должен быть готов к работе.

!!! Перед установкой Docsinum необходимо установить npm, Yarn, или dotnet. Требуется только один из этих трех инструментов, хотя все три могут быть установлены на вашем компьютере. Это на ваше усмотрение. 🙌

Поддерживаются все операционные системы, включая Mac, Windows и Linux. !!!


Возможности

:icon-shield-check: Работает просто

Docsinum создан так, чтобы использовать его было легко и он должен "просто работать" без особых настроек или проблемной установки.

:icon-zap: Быстрый как молния

Не моргайте. Docsinum создан для скорости.

:icon-gear: Простая установка

Установка займет всего несколько секунд. Вам потребуется только один файл Markdown .md из которого Docsinum начнет создание нового веб-сайта.

:icon-plug: Мощность

Уровень проекта configuration с использованием retype.yml разблокирует множество дополнительных функций и настроек.

:icon-pencil: Простое форматирование

Страницы форматируются с использованием синтаксиса Markdown и компонентов Retype. Доступна конфигурация страницы, такая как установка пользовательской навигации label или icon.

:icon-sync: Обновление в режиме реального времени

Если изменение обнаружено, например, редактирование и сохранение файла .md, ваш веб-сайт Docsinum будет обновлен практически мгновенно в браузере.

:icon-server: Размещайте в любом месте

Docsinum генерирует базовый HTML-сайт, который вы можете разместить на любой веб-хостинговой службе или бесплатно с использованием GitHub Pages. Не требуется специальное серверное программное обеспечение или внешние зависимости. Вы можете разместить свой сайт Retype как публичный веб-сайт или как частный сайт в вашей организации.


Поддержка

Если у вас есть вопрос по технической поддержке, найдена ошибка или вы хотите сделать запрос на новую функцию, пожалуйста, создайте запрос, и мы немедленно рассмотрим его.

У вас есть общий вопрос? Пожалуйста, не стесняйтесь связаться с нами по адресу [email protected].

Мы ❤️ обратную связь.