문서 도구 데모¶

테마 체크리스트¶

이 데모는 BeeWare MkDocs Material 테마 오버라이드의 다양한 기능을 테스트하기 위해 설계되었습니다. 본 페이지 및 다음 페이지에 나열된 모든 항목이 설명된 대로 존재하고 작동하는지 확인하시기 바랍니다.

페이지에 중간 회색 제목 표시줄이 있습니다. 이 테마 템플릿이 적용되었습니다.

헤더 아이콘(왼쪽 상단)이 렌더링되었습니다. 이는 템플릿이 외부 리소스를 참조할 수 있음을 확인시켜 줍니다.

왼쪽 사이드바의 로고 아이콘이 표시되었습니다. 로고는 사이드바의 너비와 동일한 너비와 동일한 높이를 가져야 합니다. 사이트 제목은 그 아래에 사이드바의 나머지 부분보다 약간 큰 글꼴로 표시되어야 하며, 그 아래에는 더 작은 글꼴로 버전 번호가 표시되어야 합니다.

이로써 사이드바가 대상 사이트에서 정상적으로 렌더링될 것임을 확인합니다.

제목은 이탤릭체로 표시됩니다. 이는 BeeWare 사용자 정의 CSS 테마가 적용되었음을 확인해 줍니다.

인라인 코드는 주변 글꼴과 동일한 색상으로 렌더링됩니다. 이는 테마가 원치 않는 변경을 일으키지 않았음을 확인시켜 줍니다.

여기에 inline code가 있고 여기에 inline code가 있는 텍스트입니다.

코드는 배경과 대비되는 색상으로 표시됩니다. 복사 버튼은 명령어만 복사해야 하며, 프롬프트는 포함되지 않아야 합니다.

이것은 테마가 원치 않는 변경 사항을 일으키지 않았음을 확인해 주며, 복사 버튼이 예상대로 작동하는지도 확인해 줍니다.

macOSLinuxWindows

$ git clone https://github.com/beeware/beeware-theme.git

$ git clone https://github.com/beeware/beeware-theme.git

C:\...>git clone https://github.com/beeware/beeware-theme.git

다음 코드 블록의 복사 버튼을 누르면 from pathlib import Path가 클립보드에 복사되어야 합니다.

from pathlib import Path

다음 코드 블록의 복사 버튼을 누르면 ls beeware-docs-tools가 클립보드에 복사되어야 합니다. 셸 프롬프트와 출력은 포함되지 않아야 합니다.

(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt  tox.ini
docs pyproject.toml    requirements.docs.txt
LICENSE README.md    src

사이드바 링크가 존재하며 beeware-docs-tools 저장소를 가리킵니다. 이는 사이드바 콘텐츠가 로드되었고, MkDocs 구성 파일에서 project-name가 설정되었으며, 버전 번호가 계산되어 추가되었음을 확인시켜 줍니다.

BeeWare 메인 웹사이트으로 연결되는 이 링크는 밝은 모드와 어두운 모드 모두에서 파란색이어야 합니다.

좌우 사이드바의 링크도 두 모드 모두에서 파란색이어야 합니다.

페이지를 아래로 스크롤할 때, 오른쪽 사이드바의 활성 헤더 링크는 다크 모드에서는 밝은 파란색으로, 라이트 모드에서는 더 진한 파란색으로 표시되어야 합니다.

이 문서의 영어 버전에는 아래의 "번역본이 제공됩니다" 경고문이 표시되어야 합니다. 프랑스어 번역본에는 "이것은 기계 번역입니다!" 경고문이 표시되어야 합니다. 독일어 번역본에는 인간 번역에 대해 "이것은 번역본입니다!" 경고문이 표시되어야 합니다.

이것은 기계 번역입니다!

이 튜토리얼 버전은 기계 번역으로 생성되었습니다. 이상적인 방법은 아니라는 점을 알고 있지만, 번역이 전혀 없는 것보다는 불완전한 번역이라도 제공하는 것이 낫다고 판단했습니다.

브라우저의 URL 끝에 nopage를 추가하여 404 페이지가 존재하는지, 그리고 "Brutus가 찾고 계신 내용을 찾을 수 없습니다"라는 텍스트가 포함되어 있는지 확인하세요. 현재 404 페이지는 MkDocs의 문제로 인해 이미지를 항상 렌더링하지는 않습니다.

MkDocs 빌드는 인식되지 않는 내부 링크로 인해 실패하므로, 브라우저에서 URL을 수동으로 수정하여 이 검사를 직접 확인해야 합니다.

다음 링크를 클릭하면 BeeWare 문서 도구 데모 섹션 1로 이동합니다. 이 링크는 페이지 간 링크를 확인하기 위해 포함되었습니다.

다음 검사를 위해 BeeWare 문서 도구 데모 섹션 1로 이동하십시오.