markdown zen

МаркдаунДзен

MarkdownZen — это веб-приложение, предназначенное для оптимизации создания и управления документами с уценкой. Благодаря удобному интерфейсу и мощным функциям MarkdownZen — это ваш идеальный инструмент для эффективного использования уценок.

Оглавление

• Начиная
  • Предварительные условия
  • Установка
• Использование
• Функции
• Запуск с Docker
• Содействие
• Лицензия

Начиная

Предварительные условия

Прежде чем начать, убедитесь, что на вашем компьютере установлено следующее программное обеспечение:

• Node.js
• npm (менеджер пакетов узлов)

Установка

1. Клонируем репозиторий :

   Откройте терминал/командную строку и перейдите к месту, где вы хотите сохранить проект. Затем выполните следующую команду:

git clone https://github.com/daniel752/markdown-zen.git

Файлы проекта будут загружены на ваш компьютер.

2. Перейдите в папку проекта :

Используйте команду cd , чтобы изменить рабочий каталог на папку клонированного проекта:

cd markdown-zen

3. Установить зависимости :

Внутри папки проекта установите необходимые зависимости как для сервера, так и для клиента с помощью одной команды:

npm run setup-project

При этом будут установлены необходимые пакеты для серверного и клиентского компонентов приложения.

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

1. Запустите приложение :

Чтобы запустить приложение, выполните следующую команду в корневой папке (markdown-zen/):

npm run dev

Эта команда одновременно запускает и сервер, и клиент, поэтому вы можете получить доступ к приложению в своем браузере.

2. Доступ к приложению :

Откройте веб-браузер и перейдите по адресу http://localhost:5173 . Здесь вы найдете приложение MarkdownZen.

3. Создание и управление уценками :

• Войдите или создайте учетную запись.
• Начните создавать документы с уценкой и управлять ими без особых усилий.

Функции

• С легкостью создавайте, редактируйте и управляйте документами с уценкой.
• Предварительный просмотр уценки в реальном времени во время редактирования.
• Организуйте уценки с помощью категорий и тегов.
• Безопасная система аутентификации и авторизации.
• ...

Запуск с Docker

Вы также можете запустить MarkdownZen с помощью Docker. Выполните следующие действия:

1. Извлеките образ Docker :

   Извлеките образ MarkdownZen Docker из Docker Hub:

   docker pull daniel752/markdown-zen:v1.0.0
   

2. Запустите контейнер :

   Запустите контейнер MarkdownZen:

   docker run -d daniel752/markdown-zen:v1.0.0
   
   

• -d: запустить контейнер в автономном режиме (в фоновом режиме).
• Контейнер будет использовать порт 8000 внутри и 5173 снаружи.

Содействие

Мы приветствуем вклад сообщества! Чтобы внести свой вклад в MarkdownZen, выполните следующие действия:

1. Форкируем репозиторий :

Нажмите кнопку «Развилка» в правом верхнем углу страницы репозитория GitHub. Это создаст копию репозитория под вашей учетной записью GitHub.

2. Клонируйте свою вилку :

Клонируйте разветвленный репозиторий на локальный компьютер:

git clone https://github.com/your-username/markdown-zen.git

3. Создайте новую ветку :

Перейдите в каталог проекта:

cd markdown-zen

Создайте новую ветку для вашей функции:

git checkout -b feature/my-new-feature

4. Внесите изменения :

Внесите необходимые изменения и зафиксируйте их:

git commit -m 'Add some feature'

5. Отправьте свои изменения :

Отправьте изменения в раздвоенный репозиторий:

git push origin feature/my-new-feature

6. Отправьте запрос на извлечение :

Посетите исходный репозиторий на GitHub и нажмите кнопку «Новый запрос на включение», чтобы отправить изменения на проверку.

Лицензия

Этот проект лицензируется по лицензии MIT. Подробности смотрите в файле ЛИЦЕНЗИИ.