Insights
AI가 자동으로 큐레이션·번역·정리하는 기술 동향 피드입니다.
본 문서는 Dash 기반의 애플리케이션과 데이터 과학 워크플로우를 문서화하기 위한 보일러플레이트를 소개합니다. 마크다운을 사용하여 콘텐츠를 작성하고, 인터랙티브 예제 및 코드 하이라이팅 기능을 제공하여 아름답고 기능적인 문서를 쉽게 구축할 수 있습니다.
AI 자동 생성 콘텐츠
본 콘텐츠는 GitHub Claude Ecosystem의 원문을 AI가 자동으로 요약·번역·분석한 것입니다. 원 저작권은 원저작자에게 있으며, 정확한 내용은 반드시 원문을 확인해 주세요.
원문 바로가기<!-- One badge for both: cd.yml's first job `uses:` ci.yml, so this status IS the full CI matrix plus the deploy — the deploy cannot start unless CI passed. A standalone ci.yml badge would be frozen forever on the last pre-1.2.2 run: ci.yml deliberately has no push trigger on main (see the comment at the top of that file), and reusable-workflow calls count as runs of the CALLER, so ci.yml never gets a new run on main again. -->
dash-documentation-boilerplate— 모든*.2plot.dev컴포넌트 사이트가 포크하는 마크다운 기반 문서화 템플릿입니다. Pip Install Python에 의해 작성되었습니다.
CI/CD
Dash
DMC
Backends
Python
License: MIT
실시간 데모: boilerplate.2plot.dev · 모든 2plot.dev 컴포넌트 문서 사이트가 구축되는 템플릿입니다.
Dash 컴포넌트, 데이터 과학 워크플로우 및 애플리케이션에 대한 아름답고 인터랙티브한 문서를 생성하기 위한 포괄적인 보일러플레이트입니다. 마크다운 기반 콘텐츠, 실시간 코드 예제, 자동 테마 지속성 기능을 제공합니다.
Documentation Preview
aria-label이 포함되어 있어 스크린 리더와 AI 에이전트가 모든 버튼의 이름을 지정할 수 있습니다 (Lighthouse Agentic-Browsing 3/3).public / auth / admin / hidden)이 있으며, PAGE_DEFAULT_TIER로 기본 설정됩니다./admin/control-board — 페이지의 계층이나 llms.txt 노출 여부를 재시작 없이 변경할 수 있습니다. 이는 프론트매터를 덮어쓰며 마운트된 디스크의 PAGE_VISIBILITY_FILE에 지속적으로 저장됩니다. 소유자/관리자 전용이며, ADMIN_EMAILS / ADMIN_USER_IDS를 통해 접근이 통제됩니다. Clerk가 없을 경우 안전하게 실패하며 (ALLOW_UNGATED_ADMIN=1은 로컬 작업용), 닫힌(fails closed) 상태로 유지됩니다.lib/auth_demos.py)가 포함된 로그인 게이트 카드 — 익명의 방문자는 "무료 계정 만들기" 카드 위에 작동하는 예시를 볼 수 있습니다.dash-clerk-auth)을 지원하며, CLERK_* 환경 변수가 존재할 때까지 완전히 비활성화됩니다. 포크된 버전은 로그인 벽이 아닌 기능을 상속받습니다.LLMS_DOC 패턴: 페이지당 모듈 레벨의 산문 문자열을 작성하며, /<page>/llms.txt에서 그대로 제공됩니다.add_llms_routes(app)가 Flask, FastAPI 또는 Quart를 자동으로 감지하고 일치하는 어댑터로 라우팅합니다.dash.mcp 리소스로 등록됩니다 (그 외 버전에서는 조용한 무시 처리).sitemap.xml; mark_hidden()을 존중합니다.mark_hidden()을 사용하여 페이지를 sitemap, robots, MCP 및 크롤러 프리렌더링에서 제외합니다.lib/network_directory.py는 형제 사이트들을 게시하여 에이전트가 하나의 위성점에 착륙했을 때 나머지 사이트를 찾을 수 있게 합니다 (docs)requirements.txt에 버전이 고정되어 있습니다 (2.6.0, 2plot 네트워크 표준 — 진실한 sitemap <lastmod>, 아이콘 자동 발견, JSON-LD 퍼블리셔 로고); 제공되는 페이지는 하드코딩된 값이 아닌 설치된 패키지에서 버전을 읽습니다.DASH_BACKEND 환경 변수로 전환합니다.lib/backend.py에 중앙 집중화되어 있으며, 라이브 배지가 어떤 백엔드가 페이지를 제공하는지 보여줍니다./api/backend, /api/pages, /healthz), 그리고 ASGI 미들웨어를 사용할 수 있게 합니다.tests/test_python_version.py에서 이들을 하나의 마이너 버전으로 유지함)~=4.4.1 — 아래 지원 매트릭스 참조; 4.3.0 아님--no-deps 사용 — 아래 참조)선택적 백엔드 (Flask 비활성화를 위해 일치하는 extra 설치):
pip install
| Dash | Flask | FastAPI | Quart |
|---|---|---|---|
| 4.1.0 | ✅ | — pluggable backends 없음 | — |
... |
4.3.0에서는 `set_current_request`보다 *먼저* 반환하는 early-return path guard를 ASGI 미들웨어에 추가했습니다. 이로 인해 페이지 catch-all은 여전히 `get_current_request()`를 호출하지만, `RuntimeError: No active request in context`가 발생합니다. catch-all 부분 자체는 4.2.0과 4.3.0 사이에 바이트 단위로 동일하며, 미들웨어만 변경되었습니다. 4.4.0에서는 catch-all 내부에서도 컨텍스트를 설정하여 이를 수정했습니다.
이 차이는 pin에 중요합니다: 4.2.0은 단일 상위 코드 경로가 우연히 커버하기 때문에 작동하는 반면, 4.4.x는 두 곳 모두에서 컨텍스트를 설정하므로 미래의 미들웨어 guard가 버그를 재도입할 수 없습니다. **4.4.x는 단순히 현재 통과하는 것을 넘어 구조적으로 더 안전합니다.**
`~=4.4.1`은 20개의 pull request 없이 4.4.2 패치를 적용할 수 있게 하지만, 4.5.0은 차단하므로 마이너 버전 업그레이드가 의도적으로 매트릭스를 통과하게 합니다. 이 pin은 Flask 전용 앱을 포함하여 **네트워크 전체에서 가장 제약이 많은 백엔드**를 위한 것입니다 — `DASH_BACKEND`는 환경 변수이며 이 리포지토리는 공유 템플릿이므로, Flask 배포는 환경 변수 변경과 코드 변경 없이 FastAPI 배포가 됩니다.
**`dash-improve-my-llms`에 대한 참고 사항.** 현재 버전은 **2.6.0**입니다. 이는 2.5.1의 Tier-B SEO 표준에 정직성 계층(honesty layer)이 추가된 것입니다: 사이트맵 `<lastmod>`는 선언된 대로 그대로 방출되며, 설정되지 않은 경우 생략됩니다 (이전 패키지는 날짜를 조용히 무시하고 사이트맵은 거짓말을 하러 돌아갑니다). 아이콘 자동 발견(icon autodiscovery), JSON-LD publisher.logo가 포함됩니다. 그 아래에는 Tier-B SEO 표준이 있습니다: `configure_seo` (아이콘, 소셜 카드, 퍼블리셔/sameAs), 사이트 이름을 담는 크롤러 `<title>`, 페이지별 `title`/`image_url`/`schema_type`이 크롤러 문서에 도달하는 것, 앱 셸(app shell) 대신 리디렉트를 응답하는 `/favicon.ico`, 그리고 앱 자체의 페이지별 `<title>`을 절대 손상시키지 않는 프리렌더링(prerender)입니다. 이전 버전도 역사적으로 중요합니다: 2.3.4는 이 사이트의 게시된 정체성(`resolve_site_title`이 `Home`이나 Dash의 기본값인 `Dash` 같은 일반적인 후보를 건너뛰게 합니다 — 그 이전에는 이 호스트의 뷰어 칩이 단순히
**Node 패키지** (DMC 프론트엔드 컴포넌트용):**
```bash
npm install
./scripts/dev.sh # .env 기반 백엔드 (기본 flask)
./scripts/dev.sh fastapi # 한 번의 실행을 위한 오버라이드
브라우저에서 **http://localhost:8559**로 접속하세요.
scripts/dev.sh는 자체 위치에서 인터프리터를 해결하므로 항상 이 프로젝트의 .venv를 사용합니다. python run.py도 작동하지만, 다른 프로젝트의 가상 환경을 가리키도록 IDE 실행 구성을 설정하면 해당 프로젝트의 의존성 버전에 맞춰 앱이 시작되는데, 이는 조용하고 비용이 많이 듭니다: dash-improve-my-llms 2.0.0에는 뷰어 모듈 자체가 없으므로, /<page>/llms.txt는 모두에게 일반 Markdown을 제공하며 아무것도 고장난 것처럼 보이지 않습니다. 이제 앱은 지정된 플로어를 아래로 부팅하는 것을 거부하고 sys.executable를 출력하지만, 이 런처는 아예 그 질문을 피합니다.
docs 폴더에 문서를 생성하세요:
docs/
├── your-component/
│ ├── your-component.md # Markdown 문서
...
dash-documentation-boilerplate/
├── assets/ # 정적 자산 및 CSS
│ ├── m2d.css # Markdown-to-Dash 스타일링 (테마 인식)
...
docs/ 디렉터리에 새 폴더를 만드세요:
mkdir -p docs/my-component
2. 프런트매터(frontmatter)가 포함된 **마크다운 파일**을 생성하세요:
```markdown
---
name: My Component
description: 마이 컴포넌트에 대한 설명
...
import dash_mantine_components as dmc
...
4. 마크다운에서 **지시어(directives)**를 사용하세요:
```markdown
.. toc::
.. exec::docs.my-component.example
...