docs.surrealdb.com

это окончательное облако
База данных для завтрашних приложений

Развиваться проще. Строить быстрее. Масштабировать быстрее.

Документация для SurreAldB, построенная с использованием Astro.

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

Начало работы с SurreaLDB

Посетите Surreaildb.com/docs, чтобы начать работу с Surreaildb.

Узнайте SurreAldb

• Университет SURREALDB: https://surrialdb.com/learn/fundamentals
• Сюрреалистическое ренессанс Эон (Межтевая книга): https://surreaildb.com/learn/book
• Документация: https://surrialdb.com/docs

Внесение в документацию

Пожалуйста, посмотрите наши рекомендации.

Хорошие первые проблемы

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

Установка

Чтобы начать с участия в документации SURREALDB, сначала установите необходимые пакеты, используя следующую команду.

Этот проект использует BUN в качестве нашего менеджера пакетов. Если вы еще не установили Bun, пожалуйста, см. Руководство по установке для вашей операционной системы. Это также требует node.js v20.0.0 или выше.

bun i 

Разработка

Следующая команда запускает локальный сервер разработки и открывает окно браузера. Большинство изменений отражаются в прямом эфире без необходимости перезапуска сервера.

 bun dev

Здание

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

 bun run build

Структура файла

Чтобы внести свой вклад в документацию, большинство ваших изменений будут внесены в каталог src/content . Каждый раздел документации имеет свой собственный подкаталог, и каждая страница является файлом MDX.

src/
    assets/
    components/
    content/
        doc-surrealdb/
        doc-surrealql/
        doc-surrealist/
        ...
    layouts/
    pages/
    styles/
    util/ 

Лининг

Чтобы гарантировать, что документация является последовательной и следует из нашего руководства по стилю, мы используем make qc для проверки ошибок в считанном виде. Вы также можете использовать make qa для автоматического исправления большинства ошибок.

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

• make install - установить зависимости, в первый раз или при изменении
• make dev - запустите сервер разработки
• make build - строить сайт
• make preview - предварительный просмотр сборки, которую вы сделали
• make qc - проверьте качество кода (FMT + Lint)
• make qa - применить безопасные предложения по качеству кода
• make qau - применить (ООН) безопасные предложения по качеству кода