gitbook

Gitbook

Документы - Сообщество - Документы разработчика - Чангейлог - Отчеты об ошибках

Добро пожаловать в Gitbook, платформу для управления техническими знаниями для команд.

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

Оглавление

• Начиная

• Внося

• Типы вкладов

• Лицензирование

• Благодарности

• Legacy Gitbook

Начиная

Чтобы запустить локальную версию этого проекта, пожалуйста, выполните эти простые шаги.

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

• Node.js (версия:> = 18.x)

• Булочка

Настраивать

1. Клонировать репо в публичный репозиторий GitHub. Если вы планируете распространять код, держите исходный код публичным, чтобы соответствовать GNU GPLV3. Чтобы клонировать в частном репозитории, приобрести коммерческую лицензию.

git clone https://github.com/gitbookIO/gitbook.git

2. Убедитесь, что вы используете версию node проекта. Запуск nvm use изменит вашу локальную версию на правильную.

3. Установите зависимости проекта через булочку.

bun install

4. Начните свой локальный сервер разработки.

bun dev

5. Откройте опубликованное пространство GitBook в вашем веб -браузере, префикс его с помощью http://localhost:3000/ .

Примеры:

• http: // localhost: 3000/docs.gitbook.com

• http: // localhost: 3000/open-source.gitbook.io/midjourney

Любого опубликованного сайта GitBook можно получить через ваш местный экземпляр разработки, и любые обновления, которые вы вносите в кодовую базу, будут отражены в вашем браузере.

Другие команды разработки

• bun format : форматируйте код

• bun lint : Lint the Code

CI и тестирование

Все запросы на притяжение будут протестированы как на визуальные, так и на тестирование на выступления для предотвращения регрессий.

Внося

Двигатель рендеринга GitBook полностью открыт и построен на вершине next.js. Отправляйтесь в наше руководство, чтобы узнать больше о рабочем процессе, добавив свой первый запрос на привлечение.

Типы вкладов

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

Переводы

Пользовательский интерфейс GitBook отображается с использованием набора файлов перевода, найденных в packages/gitbook/src/intl/translations . Мы приветствуем все дополнительные переводы для пользовательского интерфейса.

Ошибки

Встретить ошибку или найти проблему, которую вы хотели бы исправить? Помощь в решении проблем, связанных с GitBook, значительно улучшает опыт для всех. Отправляйтесь в раздел «Проблемы этого репозитория», чтобы узнать больше о типах ошибок, с которыми вы уже можете помочь.

Развертывание

Предупреждение

Хотя можно самостоятельно самостоятельно самостоятельно, мы не рекомендуем это, если вы не уверены, что эта опция соответствует вам потребности.

Хотите добавить конкретную функцию в GitBook? Отправляйтесь в наше руководство для начала.

Самостояние этот проект ставит ответственность за поддержание и объединение будущих обновлений на вас . Мы не можем гарантировать поддержку, техническое обслуживание или обновления в раздробленных и самостоятельных случаях этого проекта.

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

Этот проект позволяет вам самостоятельно управлять частью опубликованного контента GitBook. Самоунижение имеет плюсы и минусы.

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

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

Лицензия

Распределено по лицензии GNU GPLV3.

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

Смотрите LICENSE для получения дополнительной информации.

Значки

 [! [GitBook] (https://img.shields.io/static/v1?message=documented%20on%20gitbook&logo=gitbook&logocolor=ffffff&label=%20&labelcolor=5c5c5c&color=3f89a1) (https://gitbook://gitbook

 <a href = "https://gitbook.com"> <imgsrc = "https://img.shields.io/static/v1?message=documented%20on%20gitbook&logo=gitbook&logocolor=ffffff&label=%20&labelcolor=5c5color=ffffffffffffфо "
    /> </a>

Благодарности

GitBook не был бы возможен без этих проектов:

• Next.js

• Булочка

• Tailwind CSS

• Период движения

Участники

Legacy GitBook (устаревший)

Наша предыдущая версия GitBook и его инструмент CLI теперь устарела. Вы все еще можете просмотреть старый репозиторий, и он занимается этой ветвью.