docs.surrealdb.com

최고의 구름입니다
내일의 응용 프로그램을위한 데이터베이스

더 쉽게 개발합니다. 더 빨리 구축하십시오. 더 빨리 스케일.

Astro를 사용하여 구축 된 SurrealDB에 대한 문서.

기여하려면 기여 지침을 읽으십시오.

SurrealDB로 시작합니다

artrealdb.com/docs를 방문하여 SurrealDB를 시작하십시오.

SurrealDB를 배우십시오

• SurrealDB University : https://surrealdb.com/learn/fundamentals
• 이온의 초현실적 인 르네상스 (Interative Book) : https://surrealdb.com/learn/book
• 문서 : https://surrealdb.com/docs

문서에 기여합니다

기고 가이드 라인을 참조하십시오.

좋은 첫 번째 문제

우리는 비교적 제한된 범위가있는 버그를 포함하는 좋은 첫 번째 문제 목록이 있습니다. 이곳은 시작하고 경험을 쌓고 기여 과정에 익숙해지기에 좋은 곳입니다.

설치

SurrealDB 문서에 기여하기 시작하려면 먼저 다음 명령을 사용하여 필요한 패키지를 설치하십시오.

이 프로젝트는 BUN을 패키지 관리자로 사용합니다. BUN을 아직 설치하지 않은 경우 운영 체제의 설치 안내서를 참조하십시오. 또한 node.js v20.0.0 이상이 필요합니다.

bun i 

개발

다음 명령은 로컬 개발 서버를 시작하고 브라우저 창을 엽니 다. 대부분의 변경 사항은 서버를 다시 시작하지 않고도 라이브로 반영됩니다.

 bun dev

건물

다음 명령은 build 디렉토리에 정적 컨텐츠를 빌드하고 생성 한 다음 모든 정적 내용 호스팅 서비스를 사용하여 제공 될 수 있습니다.

 bun run build

파일 구조

문서에 기여하기 위해 대부분의 변경 사항은 src/content Directory로 이루어집니다. 문서의 각 섹션에는 자체 하위 디렉토리가 있으며 각 페이지는 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 -UN (UN) 안전한 코드 품질 제안을 적용하십시오