MkDocs 열 시트

MkDocs - Markdown

프로젝트 문서

MkDocs는 건물 프로젝트 문서에 Geared 빠른, 단순하고 downright 화려한 정적 사이트 생성기입니다. Documentation 소스 파일은 Markdown에서 작성되며 단일 YAML 구성 파일로 구성됩니다.

To 모든 명령 복사 < PDF 생성

본문 바로가기

• 설치
• 시작
• 프로젝트 구조
• 구성
• 문서 작성
• 네비게이션
• 테마
• 펄진
• 확장
• 직업
• 주문 테마
• 고급 구성
• 국제화
• 검색
• API 문서
• 공연
• 모범 사례

설치하기

Python 설치

카지노사이트

MkDocs 설치

카지노사이트

가상 환경 (추천)

카지노사이트

회사연혁

카지노사이트

시작하기

새 프로젝트 만들기

카지노사이트

기본 명령

카지노사이트

첫 번째 문서

카지노사이트

카지노사이트

프로젝트 구조

기본 구조

카지노사이트

고급 구조

카지노사이트

다 언어 구조

ο 회원 관리

제품 설명

기본 설정

카지노사이트

고급 구성

카지노사이트

환경 별 제품 설명

카지노사이트

문서 작성

Markdown 기초

카지노사이트

코드 블록

```피스톤
def hello_world():
print("안녕하세요!")

```python 제목="example.py" (이름)를 품으십시오: 반환 f"Hello, {name}!"

인쇄 (greet("MkDocs"))

```python 라인 nums="1"
방어 fibonacci (n):
n <= 1:
반환 n
반환 fibonacci (n-1) + fibonacci (n-2)

```python hl_lines="2 3"의 경우 def process_data(데이터): cleaned_data = 깨끗한 (데이터) # 이 선은 강조 result = 분석(cleaned_data) # 이 선은 강조 반환 결과

````를 선택합니다.

### 사이트맵
카지노사이트

### 광고
오프화이트

### 콘텐츠 탭
```markdown
=== "Python"


```피스톤
()를 뺍니다:
print("Hello from Python!")
__CODE_BLOCK_23_javascript를 사용
함수 hello() 이름 *
console.log("여기에 자바스크립트!");
이름 *

Bash

```bash의 경우 echo "Bash에서 헬로!" 카지노사이트

공지사항

카지노사이트

- 연혁

간단한 설명

카지노사이트

Hierarchical 항법

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - Overview: user-guide/index.md
    - Basic Usage: user-guide/basic.md
    - Advanced Usage: user-guide/advanced.md
  - API Reference:
    - Overview: api/index.md
    - Authentication: api/auth.md
    - Endpoints:
      - Users: api/endpoints/users.md
      - Posts: api/endpoints/posts.md
      - Comments: api/endpoints/comments.md
```의 경우

### 자동 생성된 항법
```yaml
# Automatic navigation based on file structure
# Remove nav section to enable auto-generation

plugins:
  - awesome-pages:
      filename: .pages
      collapse_single_pages: true
      strict: false
```에 대하여

```yaml
# docs/.pages
nav:
  - index.md
  - getting-started
  - user-guide
  - api
  - ...
```의 경우

### 외부 링크로 이동
```yaml
nav:
  - Home: index.md
  - Documentation:
    - User Guide: user-guide.md
    - API Reference: api.md
  - External Links:
    - GitHub: https://github.com/username/project
    - Issues: https://github.com/username/project/issues
    - Discussions: https://github.com/username/project/discussions
```에 대하여

## 이름 *

### 물자 물자 이름 *
```bash
# Install Material theme
pip install mkdocs-material
```의 경우

카지노사이트

### 자세히보기 이름 *
카지노사이트

### 사용자 정의 테마 구성
카지노사이트

### 테마 전환
카지노사이트

## 플러그인

### 필수 플러그인
카지노사이트

### 검색 플러그인
카지노사이트

### Git Revision 날짜 플러그인
```yaml
plugins:
  - git-revision-date-localized:
      type: date
      timezone: UTC
      locale: en
      fallback_to_build_date: false
      enable_creation_date: true
```의 경우

### Minify 플러그인
```yaml
plugins:
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true
```의 경우

### 멋진 페이지 플러그인
카지노사이트

### Redirects 플러그인
```yaml
plugins:
  - redirects:
      redirect_maps:
        'old-page.md': 'new-page.md'
        'old-section/index.md': 'new-section/index.md'
        'legacy/': 'current/'
```의 경우

### 사용자 정의 플러그인 구성
```yaml
plugins:
  - search
  - minify:
      minify_html: true
  - git-revision-date-localized:
      type: datetime
      timezone: America/New_York
  - awesome-pages
  - redirects:
      redirect_maps:
        'changelog.md': 'development/changelog.md'
  - macros:
      module_name: docs/macros
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
```를 호출합니다.

## 제품정보

### PyMdown 확장
```bash
# Install PyMdown Extensions
pip install pymdown-extensions
```의 경우

```yaml
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      title: On this page
  - tables

  # PyMdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: username
      repo: repository
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
```로

### 부호 하이라이트
카지노사이트

### Math 지원
오프화이트

카지노사이트

## 계정 만들기

### GitHub 페이지
__CODE_BLOCK_49_로그

### GitHub 작업
카지노사이트

### 다운로드
```toml
# netlify.toml
[build]
  publish = "site"
  command = "mkdocs build"

[build.environment]
  PYTHON_VERSION = "3.8"

[[redirects]]
  from = "/*"
  to = "/index.html"
  status = 200
```를 호출합니다.

### 다운로드
```json
{
  "builds": [
    {
      "src": "mkdocs.yml",
      "use": "@vercel/python"
    }
  ],
  "routes": [
    {
      "src": "/(.*)",
      "dest": "/site/$1"
    }
  ]
}
```의 경우

### Docker 배포
카지노사이트

카지노사이트

### 주문 영역
```yaml
# mkdocs.yml
site_url: https://docs.example.com

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/username/project
```로

카지노사이트

## 사용자 정의 테마

### 테마 구조
카지노사이트

### 기본 템플릿
카지노사이트

### 콘텐츠 템플릿
```html
<!-- content.html -->
{% if meta.source %}
<div class="source-links">
    {% for filename in meta.source %}
        <span class="label label-primary">{{ filename }}</span>
    {% endfor %}
</div>
{% endif %}

{{ page.content }}

{% if page and page.edit_url %}
<div class="edit-page">
    <a href="{{ page.edit_url }}" class="btn btn-default">
        <i class="fa fa-edit"></i> Edit this page
    </a>
</div>
{% endif %}

{% if page and page.next_page %}
<div class="pagination">
    <a href="{{ page.next_page.url|url }}" class="btn btn-primary">
        Next: {{ page.next_page.title }}
    </a>
</div>
{% endif %}
```에

### 비밀번호
```html
<!-- nav.html -->
<div class="navbar-header">
    <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
    </button>
    <a class="navbar-brand" href="{{ nav.homepage.url|url }}">{{ site_name }}</a>
</div>

<div class="navbar-collapse collapse">
    <ul class="nav navbar-nav">
        {% for nav_item in nav %}
            {% if nav_item.children %}
                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">
                        {{ nav_item.title }} <b class="caret"></b>
                    </a>
                    <ul class="dropdown-menu">
                        {% for nav_item in nav_item.children %}
                            <li>
                                <a href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
                            </li>
                        {% endfor %}
                    </ul>
                </li>
            {% else %}
                <li {% if nav_item.active %}class="active"{% endif %}>
                    <a href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
                </li>
            {% endif %}
        {% endfor %}
    </ul>

    {% if config.repo_url %}
    <ul class="nav navbar-nav navbar-right">
        <li>
            <a href="{{ config.repo_url }}" class="navbar-link">
                <i class="fa fa-github"></i> GitHub
            </a>
        </li>
    </ul>
    {% endif %}
</div>
```의 경우

## 고급 구성

### 멀티 사이트 구성
카지노사이트

### 환경 변수
카지노사이트

### 상태 구성
```yaml
# mkdocs.yml
site_name: My Documentation

# Development configuration
dev_addr: !ENV [DEV_ADDR, '127.0.0.1:8000']

# Production configuration
site_url: !ENV SITE_URL

plugins:
  - search
  - !ENV [ANALYTICS_PLUGIN, 'null']

extra:
  analytics: !ENV [ANALYTICS_CONFIG, {}]
```의 경우

### 주문 걸이
카지노사이트

카지노사이트

## 국제화

### 다국어 설정
카지노사이트

### 언어 별 이름 *
카지노사이트

### 번역 구조
카지노사이트

## 이름 *

### 로컬 검색 구성
카지노사이트

### 외부 검색 통합
```yaml
# Algolia DocSearch
extra_javascript:
  - https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js
  - javascripts/search.js

extra_css:
  - https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css
```의 경우

카지노사이트

### 회사 소개
```html
<!-- overrides/partials/search.html -->
<div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" 
             placeholder="Search documentation" autocapitalize="off" 
             autocorrect="off" autocomplete="off" spellcheck="false" 
             data-md-component="search-query">
      <label class="md-search__icon md-icon" for="__search">
        <svg viewBox="0 0 24 24"><path d="M9.5,3A6.5,6.5 0 0,1 16,9.5C16,11.11 15.41,12.59 14.44,13.73L14.71,14H15.5L20.5,19L19,20.5L14,15.5V14.71L13.73,14.44C12.59,15.41 11.11,16 9.5,16A6.5,6.5 0 0,1 3,9.5A6.5,6.5 0 0,1 9.5,3M9.5,5C7,5 5,7 5,9.5C5,12 7,14 9.5,14C12,14 14,12 14,9.5C14,7 12,5 9.5,5Z"></path></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        <button type="reset" class="md-search__icon md-icon" tabindex="-1">
          <svg viewBox="0 0 24 24"><path d="M19,6.41L17.59,5L12,10.59L6.41,5L5,6.41L10.59,12L5,17.59L6.41,19L12,13.41L17.59,19L19,17.59L13.41,12L19,6.41Z"></path></svg>
        </button>
      </nav>
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
```의 경우

## API 문서

### Auto-generated API 문서
카지노사이트

```yaml
# mkdocs.yml
plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            show_object_full_path: false
            show_category_heading: true
            group_by_category: true
            heading_level: 2
```로

카지노사이트

### OpenAPI 통합
카지노사이트

카지노사이트

카지노사이트

### 수동 API 문서
```markdown
# API Reference

## Authentication

All API requests require authentication using an API key.

```http
/api/v1/users 받기
작성자: Bearer YOUR_API_KEY

Endpoints

GET /api/v1/users

Retrieve a list of users.

Parameters:

| | | | | Parameter | Type | Required | Description | | | | | | --- | --- | --- | --- | | | | | | limit | integer | No | Maximum number of users to return (default: 10) | | | | | | | | | | offset | integer | No | Number of users to skip (default: 0) | | | | |

Response:

json의 경우 이름 * "사용자": [ 이름 * "id": 1, "이름": "John Doe", "이메일": "john@example.com" 이름 * ], "총": 100, "제한": 10, "오프셋": 0 이름 *

Example:

```bash의 경우 컬 -H "절단 : Bearer YOUR_API_KEY" \ "https://api.example.com/v1/users?limit=5" __CODE_BLOCK_82_를

- 연혁

최적화

카지노사이트

캐싱 전략

```yaml

mkdocs.yml

plugins: - search: prebuild_index: true - git-revision-date-localized: enable_creation_date: true fallback_to_build_date: false

extra: version: provider: mike default: latest ```에

이미지 최적화

__CODE_BLOCK_85_로그인

카지노사이트

Lazy 선적

카지노사이트

최고의 연습

회사소개

```bash

Recommended structure

docs/ ├── index.md # Homepage ├── getting-started/ # Getting started guide │ ├── index.md │ ├── installation.md │ └── quickstart.md ├── user-guide/ # Detailed user guide │ ├── index.md │ ├── basic-usage.md │ └── advanced-features.md ├── api/ # API documentation │ ├── index.md │ ├── authentication.md │ └── endpoints.md ├── development/ # Development docs │ ├── contributing.md │ ├── testing.md │ └── changelog.md ├── assets/ # Images and files │ ├── images/ │ ├── css/ │ └── js/ └── overrides/ # Theme customizations ```에

글쓰기 모범 사례

• ** 명확한 headings 사용 ** 더 나은 탐색을위한
• **코드 예제 포함 ** 적절한 문법 강조
• ** 스크린 샷 추가 ** 시각 안내
• Write concise description 더 나은 이해
• 모든 페이지의 일관된 형식 사용
• **관련 주제들 간의 상호 참조 **

사이트 맵 사업영역

오프화이트

유지 보수 모범 사례

• **Regular 업데이트 ** 컨텐츠 전류 유지
• ** 링크 체크 ** 깨진 링크 방지
• **Performance Monitoring ** 빌드 시간
• User Feedback 개선에 대한 통합
• Version control 문서 변경
• **자동 테스트 ** 문서 빌드

---

제품정보

MkDocs는 프로젝트 문서용으로 특별히 설계된 강력한 정적 사이트 생성기입니다. 주요 특징은 다음을 포함합니다:

• Markdown-based: 간단한 Markdown 문서 작성
• Python 전원: Python 플러그인과 확장 가능
• ** 테마 지원**: Material Design를 포함한 아름다운 테마
• **라이브 미리보기 **: 개발 중 실시간 미리보기
• ** 쉬운 배포 **: 다양한 플랫폼에 간단한 배포
• **Plugin 생태계 **: 확장된 기능을 위한 플러그인의 풍부한 생태계
• 검색 통합: 외부 검색 지원으로 내장 검색
• Multi-language: 국제화 지원

MkDocs의 역량을 활용한 모범 사례 및 레버리지를 통해 사용자를 효과적으로 제공하고 프로젝트로 성장할 수 있는 전문적이고 유지 가능한 문서를 만들 수 있습니다.

<문서> 기능 copyToClipboard () 이름 * const 명령어 = document.querySelectorAll('code'); let allCommands = ''; 명령. forEach(cmd =>의 경우 모든Commands +=cmd.textContent + navigator.clipboard.write텍스(allCommands); alert('모든 명령은 클립보드에 복사!'); 이름 *

함수 생성PDF() { 창. 인쇄 (); 이름 *