깔끔하고 심플한 디자인
모바일 친화적
맞춤형
다른 레이아웃을 방해하지 않도록 설계되었습니다.
제로 초기 구성
휴고 0.43 이상
Hugo 확장 버전, 자세한 내용은 여기를 참조하세요.
Hugo 웹사이트 루트로 이동하여 다음을 실행하세요.
git submodule add https://github.com/alex-shpak/hugo-book themes/book
그런 다음hugo를 실행합니다(또는 구성 파일에서 theme: book
).
hugo server --theme book
기본적으로 테마는 content/docs
섹션의 페이지를 트리 구조의 메뉴로 렌더링합니다.
페이지 앞부분의 title
과 weight
설정하여 메뉴의 순서와 제목을 조정할 수 있습니다.
리프 번들과 index.md
의 콘텐츠를 메뉴로 사용할 수도 있습니다.
이 파일 구조가 있다고 가정하면
├── content │ ├── docs │ │ ├── page-one.md │ │ └── page-two.md │ └── posts │ ├── post-one.md │ └── post-two.md
콘텐츠가 포함된 content content/docs/menu/index.md
파일 생성
---headless: true---- [도서 예](/docs/) - [1페이지](/docs/page-one) - [2페이지](/docs/page-two)- [블로그](/posts)
그리고 사이트 구성에서 BookMenuBundle: /docs/menu
설정을 통해 활성화합니다.
예시 메뉴
예시 구성 파일
잎 묶음
섹션 posts
에 지원되는 간단한 블로그
config.yml|json|toml
파일에 추가할 수 있는 몇 가지 구성 옵션이 있습니다.
# (선택 사항) 파일 이름에 대문자를 사용하는 경우 true로 설정합니다.disablePathToLower: true# (선택 사항) 'doc' 유형 페이지에서 '최종 수정자' 날짜 및 git 작성자# 정보를 활성화하려면 이것을 true로 설정합니다.enableGitInfo: true# (경고) 테마는 문서용이므로 분류를 렌더링하지 않습니다.# underdisableKinds: ["taxonomy", "taxonomyTerm"]params: # (선택 사항, 기본값은 true) 전역적으로 목차를 표시하거나 숨깁니다. # 머리말의 페이지마다 이 매개변수를 지정할 수도 있습니다. BookShowToC: 참 # (선택 사항, 기본값 없음) 리프 번들을 사이드 메뉴로 렌더링하도록 설정 # 지정되지 않은 경우 파일 구조와 가중치가 사용됩니다. BookMenuBundle: /메뉴 # (선택사항, 기본 문서) 메뉴로 렌더링할 콘텐츠 섹션 지정 # 모든 섹션을 메뉴에 렌더링하려면 값을 "*"로 설정할 수도 있습니다. 도서섹션: 문서 # 이 값은 메뉴 번들 모드에서 활성 링크 강조 표시를 만들기 위한 $link-color와 중복됩니다. # BookMenuBundleActiveLinkColor: #004ed0 # 페이지에 JS 스크립트를 포함합니다. 기본적으로 비활성화되어 있습니다. # - 탐색 중에 사이드 메뉴를 동일한 스크롤 위치에 유지 BookEnableJS: 참 # 소스 저장소 위치를 설정합니다. # '최종 수정' 및 '이 페이지 편집' 링크에 사용됩니다. 도서 저장소: https://github.com/alex-shpak/hugo-book # '문서' 페이지 유형에 대해 "이 페이지 편집" 링크를 활성화합니다. # 기본적으로 비활성화되어 있습니다. 활성화하려면 주석을 해제하세요. 'BookRepo' 매개변수가 필요합니다. # 경로는 저장소의 'content' 디렉터리를 가리켜야 합니다. BookEditPath: 편집/마스터/exampleSite/content
머리말의 페이지당 추가 매개변수를 지정할 수 있습니다.
---# 구성된 섹션 외부의 페이지를 렌더링하거나 'docs' 이외의 섹션을 렌더링하려면 유형을 'docs'로 설정하십시오. 설정되지 않음)weight: 10# (선택 사항) 파일 트리 메뉴에서 페이지를 플랫 섹션으로 표시하도록 설정합니다(BookMenuBundle이 설정되지 않은 경우)bookFlatSection: true#(선택 사항) 목차를 숨기도록 설정하고 전역을 재정의합니다. valuebookShowToC: 거짓---
layouts/partials/
에서 재정의할 수 있는 빈 부분이 거의 없습니다.
부분 | 놓기 |
---|---|
layouts/partials/docs/inject/head.html | <head> 태그를 닫기 전 |
layouts/partials/docs/inject/body.html | <body> 태그를 닫기 전 |
layouts/partials/docs/inject/menu-before.html | <nav> 메뉴 블록의 시작 부분에 |
layouts/partials/docs/inject/menu-after.html | <nav> 메뉴 블록 끝 |
기여를 환영하며 풀 요청을 검토하고 고려하겠습니다.
주요 목표는 다음과 같습니다.
단순하게 유지하세요
최소(또는 0) 기본 구성 유지
사용자 정의 레이아웃과의 간섭 방지
일부 구성이나 사용자 정의 옵션이 누락된 경우 언제든지 문제를 열어보세요.
MIT