|
| 1 | +site_name: PaddleX 文档 #站点名称 |
| 2 | +site_url: https://zhang-prog.github.io/ |
| 3 | +docs_dir: docs # 文档路径 |
| 4 | + |
| 5 | +repo_url: https://github.com/zhang-prog/zhang-prog.github.io #仓库地址 |
| 6 | + |
| 7 | +edit_uri: edit/develop/docs/ #修改文件的路径 |
| 8 | +theme: |
| 9 | + name: material |
| 10 | + # logo: ./static/images/logo.jpg #设置左上角logo |
| 11 | + # favicon: ./static/images/logo.jpg |
| 12 | + custom_dir: overrides #用于自定义站点效果 |
| 13 | + features: |
| 14 | + - announce.dismiss |
| 15 | + - content.action.edit #可以编辑页面源码 |
| 16 | + - content.action.view #可以查看页面源码 |
| 17 | + - content.code.annotate |
| 18 | + - content.code.copy |
| 19 | + # - content.code.select |
| 20 | + # - content.footnote.tooltips |
| 21 | + # - content.tabs.link |
| 22 | + - content.tooltips |
| 23 | + # - header.autohide |
| 24 | + # - navigation.expand |
| 25 | + - navigation.footer |
| 26 | + - navigation.indexes |
| 27 | + # - navigation.instant |
| 28 | + # - navigation.instant.prefetch |
| 29 | + # - navigation.instant.progress |
| 30 | + # - navigation.prune |
| 31 | + - navigation.sections |
| 32 | + - navigation.tabs |
| 33 | + - navigation.tabs.sticky |
| 34 | + - navigation.top |
| 35 | + - navigation.tracking |
| 36 | + - navigation.expand # 默认打开所有的字节 |
| 37 | + - navigation.path |
| 38 | + - search.highlight |
| 39 | + - search.share |
| 40 | + - search.suggest |
| 41 | + - toc.follow |
| 42 | + # - toc.integrate |
| 43 | + palette: #设置切换light和dark模式 |
| 44 | + - media: "(prefers-color-scheme: light)" |
| 45 | + scheme: default |
| 46 | + primary: indigo |
| 47 | + accent: indigo |
| 48 | + toggle: |
| 49 | + icon: material/weather-sunny |
| 50 | + name: Switch to dark mode |
| 51 | + - media: "(prefers-color-scheme: dark)" |
| 52 | + scheme: slate |
| 53 | + primary: black |
| 54 | + accent: indigo |
| 55 | + toggle: |
| 56 | + icon: material/weather-night |
| 57 | + name: Switch to system preference |
| 58 | + font: |
| 59 | + text: Roboto |
| 60 | + code: Roboto Mono |
| 61 | + favicon: assets/favicon.png |
| 62 | + icon: |
| 63 | + logo: logo |
| 64 | + edit: material/pencil |
| 65 | + view: material/eye |
| 66 | + repo: fontawesome/brands/github |
| 67 | + |
| 68 | +# Additional configuration |
| 69 | +extra: |
| 70 | + version: |
| 71 | + provider: mike #显示版本 |
| 72 | + status: |
| 73 | + new: Recently added |
| 74 | + deprecated: Deprecated |
| 75 | + analytics: |
| 76 | + provider: google |
| 77 | + property: !ENV GOOGLE_ANALYTICS_KEY |
| 78 | + social: |
| 79 | + - icon: fontawesome/brands/github |
| 80 | + link: https://github.com/PaddlePaddle/PaddleX |
| 81 | + |
| 82 | +extra_javascript: |
| 83 | + - javascripts/katex.min.js |
| 84 | + - https://unpkg.com/katex@0/dist/katex.min.js |
| 85 | + - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js |
| 86 | + |
| 87 | +extra_css: |
| 88 | + - https://unpkg.com/katex@0/dist/katex.min.css |
| 89 | + |
| 90 | +# Extensions |
| 91 | +markdown_extensions: |
| 92 | + - abbr |
| 93 | + - admonition |
| 94 | + - attr_list |
| 95 | + - def_list |
| 96 | + - footnotes |
| 97 | + - md_in_html |
| 98 | + - toc: |
| 99 | + permalink: true |
| 100 | + - pymdownx.arithmatex: |
| 101 | + generic: true |
| 102 | + - pymdownx.betterem: |
| 103 | + smart_enable: all |
| 104 | + - pymdownx.caret |
| 105 | + - pymdownx.details |
| 106 | + - pymdownx.emoji: |
| 107 | + emoji_generator: !!python/name:material.extensions.emoji.to_svg |
| 108 | + emoji_index: !!python/name:material.extensions.emoji.twemoji |
| 109 | + - pymdownx.highlight: |
| 110 | + anchor_linenums: true |
| 111 | + line_spans: __span |
| 112 | + pygments_lang_class: true |
| 113 | + - pymdownx.inlinehilite |
| 114 | + - pymdownx.keys |
| 115 | + - pymdownx.magiclink: |
| 116 | + normalize_issue_symbols: true |
| 117 | + repo_url_shorthand: true |
| 118 | + user: squidfunk |
| 119 | + repo: mkdocs-material |
| 120 | + - pymdownx.mark |
| 121 | + - pymdownx.smartsymbols |
| 122 | + - pymdownx.snippets: |
| 123 | + auto_append: |
| 124 | + - includes/mkdocs.md |
| 125 | + - pymdownx.superfences: |
| 126 | + custom_fences: |
| 127 | + - name: mermaid |
| 128 | + class: mermaid |
| 129 | + format: !!python/name:pymdownx.superfences.fence_code_format |
| 130 | + - pymdownx.tabbed: |
| 131 | + alternate_style: true |
| 132 | + combine_header_slug: true |
| 133 | + slugify: !!python/object/apply:pymdownx.slugs.slugify |
| 134 | + kwds: |
| 135 | + case: lower |
| 136 | + - pymdownx.tasklist: |
| 137 | + custom_checkbox: true |
| 138 | + - pymdownx.tilde |
| 139 | + |
| 140 | +# 页面结构 |
| 141 | +nav: |
| 142 | + - 模型产线部署: |
| 143 | + - 高性能推理: pipeline_deploy/high_performance_inference.md |
| 144 | + - 服务化部署: pipeline_deploy/service_deploy.md |
| 145 | + - 端侧部署: pipeline_deploy/edge_deploy.md |
0 commit comments