websiteTeam/website
1
0
Fork 0
mirror of https://github.com/ZSCNetSupportDept/website.git synced 2026-02-10 20:29:00 +08:00
Code Activity
Files
f0f98fc13a9e90075fcddd6373b14d034c062de4
website/docs/devdocs/开发组网站/文件的组织/index.html
abc f0f98fc13a Deploy website - based on 4bd6b788e4
2025-11-03 04:45:20 +08:00

61 lines
26 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-devdocs/开发组网站/文件的组织" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.6.0">
<title data-rh="true">文件的组织 | 中山学院网络维护科</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://developer.zsxyww.com/img/docusaurus-social-card.jpg"><meta data-rh="true" name="twitter:image" content="https://developer.zsxyww.com/img/docusaurus-social-card.jpg"><meta data-rh="true" property="og:url" content="https://developer.zsxyww.com/docs/devdocs/开发组网站/文件的组织"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="文件的组织 | 中山学院网络维护科"><meta data-rh="true" name="description" content="如何组织文档的结构"><meta data-rh="true" property="og:description" content="如何组织文档的结构"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://developer.zsxyww.com/docs/devdocs/开发组网站/文件的组织"><link data-rh="true" rel="alternate" href="https://developer.zsxyww.com/docs/devdocs/开发组网站/文件的组织" hreflang="en"><link data-rh="true" rel="alternate" href="https://developer.zsxyww.com/docs/devdocs/开发组网站/文件的组织" hreflang="x-default"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="中山学院网络维护科 RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="中山学院网络维护科 Atom Feed"><link rel="stylesheet" href="/assets/css/styles.b9a55377.css">
<script src="/assets/js/runtime~main.5430e7b9.js" defer="defer"></script>
<script src="/assets/js/main.62ad852d.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,t("light"))}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="ZSCNetworkSupport_logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo.svg" alt="ZSCNetworkSupport_logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">ZSCNetworkSupport</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/">首页</a><a class="navbar__item navbar__link" href="/docs/wiki/首页">wiki</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/devdocs/首页">开发组文档</a><a class="navbar__item navbar__link" href="/blog">文章</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/ZSCNetSupportDept/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><div class="navbar__search searchBarContainer_NW3z" dir="ltr"><input placeholder="Search" aria-label="Search" class="navbar__search-input searchInput_YFbd"><div class="loadingRing_RJI3 searchBarLoadingRing_YnHq"><div></div><div></div><div></div><div></div></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/devdocs/首页">ZSCNSD-DEV Documents</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" href="/docs/devdocs/网维报修系统/">网维报修系统</a><button aria-label="Expand sidebar category &#x27;网维报修系统&#x27;" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" href="/docs/devdocs/开发组网站/">开发组网站</a><button aria-label="Collapse sidebar category &#x27;开发组网站&#x27;" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/devdocs/开发组网站/概述">概述</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/devdocs/开发组网站/文件的组织">文件的组织</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/devdocs/开发组网站/撰写内容">撰写内容</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/devdocs/开发组网站/项目构建与部署">项目构建与部署</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/devdocs/开发组网站/项目配置">项目配置</a></li></ul></li></ul></nav><button type="button" title="Collapse sidebar" aria-label="Collapse sidebar" class="button button--secondary button--outline collapseSidebarButton_PEFL"><svg width="20" height="20" aria-hidden="true" class="collapseSidebarButtonIcon_kv0_"><g fill="#7a7a7a"><path d="M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"></path><path d="M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"></path></g></svg></button></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/docs/devdocs/开发组网站/"><span itemprop="name">开发组网站</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">文件的组织</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>文件的组织</h1></header>
<p>所有的文档都采用Markdown编写，如果你对它不熟悉的话，建议看&quot;撰写内容&quot;板块，这里不再赘述。这里讲一讲Docusaurus特定的，组织文档的技巧。</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="sidebar">Sidebar<a href="#sidebar" class="hash-link" aria-label="Direct link to Sidebar" title="Direct link to Sidebar">​</a></h2>
<p>如果你使用电脑端访问本站的话，你可以看到在站点的左边有你当前访问的文档(wiki或者开发组文档)的目录，我们称之为Sidebar。</p>
<p>Sidebar本来是高度可配置的，但是我们的Sidebar配置很简单：自动搜索，原样反映<code>/docs/wiki</code>和<code>/docs/devdocs</code>下的所有文件和子目录中的文件。也就是说，这两个目录下的每个<code>.md</code>文件，都对应sidebar中的一篇文章；每个文件夹，都对应着Sidebar中的一个子栏目（右边有箭头可以展开的那个，官方的行话叫做Category,&quot;类别&quot;）。</p>
<p>这非常直观，所以如果你会Markdown的话，应该很快就可以上手开始编写文章，不过在编写之前，你需要知道如下事情：</p>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="indexmd">index.md<a href="#indexmd" class="hash-link" aria-label="Direct link to index.md" title="Direct link to index.md">​</a></h2>
<p>系统会特殊处理每个文件夹下，名为<code>index.md</code>的文件。它会被当作这个子栏目的概述文件。当你点击Sidebar的子栏目（而不是右边的箭头）时，网站就会显现相应文件夹下的<code>index.md</code>文件。</p>
<blockquote>
<p><em>官方文档:<a href="https://docusaurus.io/zh-CN/docs/sidebar/autogenerated#category-index-convention" target="_blank" rel="noopener noreferrer">链接</a>，实际上使用<code>README.md</code>也可，不过本项目约定使用<code>index.md</code></em></p>
</blockquote>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="给文件编号以排序">给文件编号以排序<a href="#给文件编号以排序" class="hash-link" aria-label="Direct link to 给文件编号以排序" title="Direct link to 给文件编号以排序">​</a></h2>
<p>默认情况下，系统会在Sidebar中按照拼音或首字母的顺序从上到下排列文档。但是如果我们想让某些文档排在前面，某些在后面，按一定的顺序排列文档该怎么办？</p>
<p>我们的做法是，将每个<code>.md</code>文件前面加上一个数字前缀：</p>
<p>例如，如果你在目录<code>wiki编写教程</code>下有如下文件：<code>如何快速编写wiki.md</code>，<code>编写wiki的高级技巧.md</code>，<code>额外说明.md</code>；如果直接这样放上去的话，系统会如下排列这些文章：</p>
<p><img decoding="async" loading="lazy" alt="演示Sidebar" src="/assets/images/build-docs-25f7c36e7488e60aad0fe01167429405.png" width="494" height="220" class="img_ev3q"></p>
<p>这完全不是我们想要的！我们想要以主题由浅入深的顺序排列文章..那么应该怎么办？正确的做法是把文件重命名为如下格式：<code>01-如何快速编写wiki.md</code>，<code>02-编写wiki的高级技巧.md</code>，<code>03-额外说明.md</code>，此时，系统会如下显示：</p>
<p><img decoding="async" loading="lazy" alt="演示Sidebar-1" src="/assets/images/build-docs-2-17d3b2b7fad613f59c3ed0da6dcf422f.png" width="498" height="216" class="img_ev3q"></p>
<p>系统在构建时会自动去除数字前标，另外这个操作对于子文件夹也适用的。</p>
<blockquote>
<p><em>官方文档:<a href="https://docusaurus.io/zh-CN/docs/sidebar/autogenerated#using-number-prefixes" target="_blank" rel="noopener noreferrer">链接</a>，官方实际上推荐在每个文档内部使用元数据的方式来标记位置，不过我们还是使用这种修改文件名的方式。因为这样简单方便，直观而且能集中管理。</em> <br> 当然我们的方法在调整顺序时可能需要连锁修改很多文件名，不过方案总归要权衡利弊～</p>
</blockquote>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="使用_忽略某些文件">使用&quot;_&quot;忽略某些文件<a href="#使用_忽略某些文件" class="hash-link" aria-label="Direct link to 使用&quot;_&quot;忽略某些文件" title="Direct link to 使用&quot;_&quot;忽略某些文件">​</a></h2>
<p>系统会忽略以<code>_</code>开头的所有文件和文件夹，它们并不会参与到构建中，所以如果你在写一些东西，而且暂时不想把它们放出来的话，可以先用<code>_</code>注释掉它们。</p>
<blockquote>
<p><em>官方文档:<a href="https://docusaurus.io/zh-CN/docs/creating-pages#routing" target="_blank" rel="noopener noreferrer">链接</a></em></p>
</blockquote>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="docs-card">docs-card<a href="#docs-card" class="hash-link" aria-label="Direct link to docs-card" title="Direct link to docs-card">​</a></h2>
<p>在站内你可以看到这样的组件：
<img decoding="async" loading="lazy" alt="cards" src="/assets/images/docs-card-1d33e0033deb974e097af65e2dbd9ac1.png" width="1595" height="799" class="img_ev3q">
它们通常出现在<code>index.md</code>中，以一系列卡片的形式展现了该子文件夹中的文件和文件夹。</p>
<p>要使用它们，请在markdown中添加如下代码：</p>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">import DocCardList from &#x27;@theme/DocCardList&#x27;;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">&lt;DocCardList className=&quot;docs-card&quot; /&gt;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<blockquote>
<p><em>官方文档:<a href="https://docusaurus.io/zh-CN/docs/sidebar/items#embedding-generated-index-in-doc-page" target="_blank" rel="noopener noreferrer">链接</a> <br> 注意，class是必要的，因为我们修改了<code>h2</code>的默认样式，而docs-card默认把标题渲染成<code>h2</code>，我们专门写了一段CSS把样式在docs-card里面改了回来。</em></p>
</blockquote>
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="为文件添加简述">为文件添加简述<a href="#为文件添加简述" class="hash-link" aria-label="Direct link to 为文件添加简述" title="Direct link to 为文件添加简述">​</a></h3>
<p>在每个文件的下面有一行小字，这是这个文件的简述。默认情况下，系统会把<code>h1</code>下的第一句话当作简述，如果你想自定义简述的话，请在那篇文章的开头添加以下内容：</p>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">---</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">description: 在这里填入你的简述</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">---</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<blockquote>
<p><em>官方文档:<a href="https://docusaurus.io/zh-CN/docs/sidebar/autogenerated#doc-item-metadata" target="_blank" rel="noopener noreferrer">链接1</a>，<a href="https://docusaurus.io/zh-CN/docs/markdown-features/head-metadata#markdown-page-description" target="_blank" rel="noopener noreferrer">链接2</a></em></p>
</blockquote>
<h3 class="anchor anchorWithStickyNavbar_LWe7" id="为目录设置简述">为目录设置简述<a href="#为目录设置简述" class="hash-link" aria-label="Direct link to 为目录设置简述" title="Direct link to 为目录设置简述">​</a></h3>
<p>当docs-card所展示的含有子目录时，可以通过在该子目录下设置一个名为<code>_category_.json</code>的文件来添加简述：</p>
<div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> &quot;description&quot;: &quot;在这里填入你的简述&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<blockquote>
<p><em>官方文档:<a href="https://docusaurus.io/zh-CN/docs/sidebar/autogenerated#category-item-metadata" target="_blank" rel="noopener noreferrer">链接</a> <br>官方文档好像说yaml也可以，我没怎么用过，你们可以尝试下</em></p>
</blockquote></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col"><a href="https://github.com/ZSCNetSupportDept/website/tree/master/docs/devdocs/03-开发组网站/02-文件的组织.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2025-11-02T20:07:13.000Z" itemprop="dateModified">Nov 2, 2025</time></b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/devdocs/开发组网站/概述"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">概述</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/devdocs/开发组网站/撰写内容"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">撰写内容</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#sidebar" class="table-of-contents__link toc-highlight">Sidebar</a></li><li><a href="#indexmd" class="table-of-contents__link toc-highlight">index.md</a></li><li><a href="#给文件编号以排序" class="table-of-contents__link toc-highlight">给文件编号以排序</a></li><li><a href="#使用_忽略某些文件" class="table-of-contents__link toc-highlight">使用&quot;_&quot;忽略某些文件</a></li><li><a href="#docs-card" class="table-of-contents__link toc-highlight">docs-card</a><ul><li><a href="#为文件添加简述" class="table-of-contents__link toc-highlight">为文件添加简述</a></li><li><a href="#为目录设置简述" class="table-of-contents__link toc-highlight">为目录设置简述</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2025 ZSCNetworkSupport,Built with Docusaurus.</div></div></div></footer></div>
</body>
</html>
View Git Blame Copy Permalink