website metalsmith

Fastify-Website

경고 :
이 저장소는 2023 년 6 월까지 Fastify 웹 사이트의 이전 집이었습니다.
새 집은 이제 fastify/website-next

이 프로젝트는 Fastify 웹 프레임 워크를위한 웹 사이트를 구축하고 온라인으로 게시하는 데 사용됩니다.

요구 사항

• 노드 12+
• npm install 로 종속성을 설치하십시오

짓다

웹 사이트의 빌드를 트리거하려면 실행하면됩니다.

npm run build

이렇게하면 빌드 (정적 웹 사이트)를 작성하는 데 필요한 모든 단계가 실행됩니다.

개발중인 경우 실행할 수 있습니다.

npm start

이렇게하면 빌드가 트리거되고 웹 사이트에서 수행하는 변경 사항을 시각화 할 수있는 라이브 서버를 시작합니다.

(웹 사이트의 컨텐츠를 구성하는 자산을 변경할 때마다 npm run build:website 재건축을 시작해야합니다)

단계를 구축하십시오

빌드 프로세스의 작동 방식에 대해 더 많이 알고 싶다면 실행 중에 수행되는 주요 단계는 다음과 같습니다.

1. 정리 : 이전 빌드에서 생성했을 수있는 임시 리소스 제거
2. 온도 폴더 생성 : 빌드 프로세스에 필요한 폴더를 만듭니다.
3. 릴리스 가져 오기 : GitHub API를 사용하여 최신 Fastify 릴리스를 다운로드하여 문서 페이지를 동적으로 재생할 수 있습니다.
4. 프로세스 릴리스 : 프로세스 프로세스 릴리스를 프로세스 원래 Fastify 릴리스에서 파생하는 모든 필요한 동적 파일을 생성합니다 (대부분 문서 페이지를 생성하고 프로세스하는 데 사용됨)
5. 웹 사이트 생성 : 금속 제조업체를 사용하여 웹 사이트의 정적 버전을 컴파일합니다.

패키지 스크립트를 확인하여 위에서 설명한 단계에 대한 코드를 살펴 보려는 경우 어떤 파일이 이러한 작업을 트리거하는 지 이해합니다.

Github 페이지로 게시

웹 사이트는 GitHub 페이지 (Branch gh-pages )를 사용하여 CI를 자동으로 서사합니다.

마스터가 변경 될 때마다 빌드가 성공적으로 만들어지면 GitHub 페이지에 자동으로 게시됩니다.

이를 위해서는 Circle CI가 필요한 모든 환경 변수를 올바르게 구성해야합니다.

• DOMAIN : GitHub 페이지에서 사용할 맞춤형 도메인 ( www.fastify.io )
• GH_EMAIL : Github 사용자의 이메일은 Circleci에서 gh-pages 지점으로 밀어 붙일 수있는 승인
• GH_NAME : Github 사용자의 사용자 이름은 Circleci에서 gh-pages 지점으로 밀어 붙일 수있는 권한
• GH_TOKEN : (선택 사항) GH_NAME 에 지정된 사용자를위한 GitHub 개인 액세스 토큰. 이것이 참석하면 Github에 대한 API 호출이 인증됩니다.
• CLOUDFLARE_EMAIL : CloudFlare 계정의 이메일
• CLOUDFLARE_AUTH_KEY : CloudFlare API에서 API 호출을 수행하는 권한 부여 키
• CLOUDFLARE_ZONE : 현재 도메인과 관련된 CloudFlare 영역의 ID

기여

모두 가이 프로젝트에 기여하는 것을 매우 환영합니다. 문제를 열거 나 풀 요청을 보내면 버그를 제출하거나 개선을 제안하는 것만으로 기여할 수 있습니다.

특허

MIT 라이센스에 따라 라이센스. © Openjs Foundation 및 Fastify 팀.