從零用VitePress搭建博客教程(5) - 如何自定義頁面模板、給頁面添加獨有的className和使頁面標題變成側邊目錄?

来源:https://www.cnblogs.com/myboogle/archive/2023/10/22/17779893.html
-Advertisement-
Play Games

接上一節:從零用VitePress搭建博客教程(4) – 如何自定義首頁佈局和主題樣式修改? 上一節其實我們也簡單說了自定義頁面模板,這一節更加詳細一點說明,開始之前我們要知道在vitePress中,.md的文件是可以直接編寫vue的代碼的。 比如我們現在來自定義一個前端網址導航頁面 八、自定義一些 ...


接上一節:從零用VitePress搭建博客教程(4) – 如何自定義首頁佈局和主題樣式修改?

上一節其實我們也簡單說了自定義頁面模板,這一節更加詳細一點說明,開始之前我們要知道在vitePress中,.md的文件是可以直接編寫vue的代碼的。

比如我們現在來自定義一個前端網址導航頁面

八、自定義一些頁面模板

1、編寫組件代碼

想自定義頁面模板樣式,該如何做呢?
我們先在theme/components下新建siteList.vue文件,編寫模板,代碼如下:

<template>
  <!-- 網址分類模塊 -->
  <section class="site-section">
     <!-- 標題 -->
    <h2 class="title">{{ props.title }}</h2>
    <!-- 網址列表 -->
    <ul class="list">
      <li class="item" v-for="(v, index) in props.data" :key="v.name">
        <a class="link" :href="v.link" target="_blank">
          <span class="num">{{ index + 1 }}</span>
          <h4 class="name">{{ v.name }}</h4>
          <p class="desc">{{ v.desc }}</p>
        </a>
      </li>
    </ul>
  </section>
</template>
<script setup>
const props = defineProps({
  title: String,
  data: {
    type: Array,
    default: [],
  },
});
 
</script>
<style lang="scss" scoped>
/*單行文本省略號*/
@mixin single-ellipsis {
  overflow: hidden;
  word-wrap: normal;
  white-space: nowrap;
  text-overflow: ellipsis;
}
.site-section {
  .title {
    color: #222;
  }
  .list {
    display: flex;
    flex-wrap: wrap;
    list-style: none;
    padding-left: 0;
    .item {
      width: 212px;
      margin: 15px 15px 0 0px;
      background: #fff;
      position: relative;
      .link {
        width: 210px;
        display: block;
        border: 1px solid #e3e3e3;
        padding-bottom: 8px;
        border-radius: 6px;
        .num {
          display: block;
          width: 24px;
          height: 18px;
          line-height: 18px;
          position: absolute;
          color: #666;
          font-size: 14px;
          text-align: center;
          right: 5px;
          top: 5px;
        }
        .name {
          width: 80%;
          height: 26px;
          padding-left: 10px;
          font-size: 16px;
          font-weight: 600;
          color: #06a4fa;
          margin-top: 15px;
          @include single-ellipsis;
        }
        .desc {
          font-size: 12px;
          margin: 10px 10px 0;
          color: #b1b1b1;
          height: 36px;
          line-height: 18px;
          @include single-ellipsis;
        }
        &:hover {
          text-decoration: none;
          border: 1px solid var(--vp-c-brand);
          filter: brightness(1.15);
          box-shadow: 0 15px 30px rgba(0, 0, 0, 0.1);
          transform: rotateY(-0.1deg) scale(1.001) translateZ(0);
          transition: all 0.24s ease;
          .name {
            color: var(--vp-c-brand);
          }
          .num {
            background: var(--vp-c-brand);
            color: #fff;
          }
        }
      }
    }
  }
}
</style>

 

2、註冊組件

上面我們寫好組件代碼後,需註冊為全局組件,如下theme/index.js的配置,把SiteList註冊為全局組件,然後在頁面引用即可。

// https://vitepress.dev/guide/custom-theme
import { h } from "vue";
import siteList from "./components/siteList.vue";
 
import DefaultTheme from "vitepress/theme";
import "./styles/custom.scss";
import "./styles/site.scss";
import "./styles/rainbow.css";
 
export default {
  ...DefaultTheme,
  NotFound: () => "404", // <- this is a Vue 3 functional component
  enhanceApp({ app, router, siteData }) {
    // app is the Vue 3 app instance from createApp()
    // router is VitePress' custom router (see `lib/app/router.js`)
    // siteData is a ref of current site-level metadata.
    app.component("SiteList", siteList);
  },
};

 

3、如何給頁面添加自定義類className

官方就有最簡單的配置方法,向特定頁面添加額外的類名pageClass:比如給page.md頁面配置,只需如下即可

---
pageClass: site-layout
---

  然後在下麵寫樣式即可

.site-layout {
  ...
}

  當然還有一種方法是:我們還可以在theme/index.js,通過js添加(Layout配置),這個一個頁面可以添加多個className了。

// https://vitepress.dev/guide/custom-theme
import { useData } from "vitepress";
import siteList from "./components/siteList.vue";
 
import DefaultTheme from "vitepress/theme";
import "./styles/custom.scss";
import "./styles/site.scss";
import "./styles/rainbow.css";
 
export default {
  ...DefaultTheme,
  NotFound: () => "404", // <- this is a Vue 3 functional component
  enhanceApp({ app, router, siteData }) {
    // app is the Vue 3 app instance from createApp()
    // router is VitePress' custom router (see `lib/app/router.js`)
    // siteData is a ref of current site-level metadata.
    // 註冊全局組件
    app.component("SiteList", siteList);
  },
  // 自定義佈局配置
  Layout: () => {
    const props = {};
    // 獲取 frontmatter
    const { frontmatter } = useData();
 
    /* 添加自定義 class */
    if (frontmatter.value?.layoutClass) {
      props.class = frontmatter.value.layoutClass;
    }
  },
};

 

  然後同樣的page.md頁面,我們可以通過layoutClass設置另一個className了,如下

---
layoutClass: site-page
pageClass: site-layout
---

  

4、頁面使用組件

同樣還是上面的page.md,我們使用組件如下

---
pageClass: site-layout
---
 
<SiteList v-for="model in siteData" :key="model.title" :title="model.title" :data="model.items" />
<script setup>
// 網址導航頁面的數據
import siteData from "./data/page.js";
</script>

 

效果

 

 

5、如何使頁面標題變成側邊目錄呢?

從上面圖中可以看出,我們發現右邊沒有側邊導航,那麼如何使頁面標題變成側邊目錄呢?

這個時候需要用到@mdit-vue/shared,siteList.vue組件修改代碼如下

<template>
  <!-- 網址分類模塊 -->
  <!-- <backTop></backTop> -->
  <section class="site-section">
    <!-- 瞄點標題 -->
    <h2 class="title" :id="createTitle">
      {{ props.title }}
      <a class="anchor" :href="`#${createTitle}`" aria-hidden="true"></a>
    </h2>
    <!-- 網址列表 -->
    <ul class="list">
      <li class="item" v-for="(v, index) in props.data" :key="v.name">
        <a class="link" :href="v.link" target="_blank">
          <span class="num">{{ index + 1 }}</span>
          <h4 class="name">{{ v.name }}</h4>
          <p class="desc">{{ v.desc }}</p>
        </a>
      </li>
    </ul>
  </section>
</template>
<script setup>
import { computed } from "vue";
import { slugify } from "@mdit-vue/shared";
const props = defineProps({
  title: String,
  data: {
    type: Array,
    default: [],
  },
});
 
// 生成側邊欄markdown的目錄
const createTitle = computed(() => {
  return slugify(props.title);
});
</script>

發現目錄已經有了,效果如下:  

 

這個時候目錄是在頁面右邊的,那麼如何變成在左側邊欄呢?我們通過樣式調整即可,site.scss

/**
  網址導航頁面樣式
**/
 
.site-layout {
  /*佈局調整*/
  .VPDoc {
    .container {
      max-width: 100% !important;
      justify-content: flex-start !important;
      .aside {
        order: 1;
      }
      .content {
        order: 2;
        max-width: 100% !important;
        .content-container {
          max-width: 100% !important;
        }
      }
      .main {
        height: auto;
        overflow: hidden;
        .vp-doc h2 {
          margin: 0;
        }
      }
    }
  }
  /* 隱藏底部的在 github 上編輯此頁模塊*/
  .VPDocFooter {
    display: none;
  }
}

  

6、如何自定義頁面的底部?

我們新建一個siteFooter.vue組件,然後在theme/index.js通過h函數配置即可,這裡使用到doc-after插槽,

預設主題佈局中可用插槽的完整列表:https://process1024.github.io/vitepress/guide/theme-introduction

<template>
  <div class="site-footer">
    網址導航自定義底部信息
  </div>
</template>
mport { h } from "vue";
import siteFooter from "./components/siteFooter.vue";
 
import DefaultTheme from "vitepress/theme";
 
export default {
  ...DefaultTheme,
  NotFound: () => "404", // <- this is a Vue 3 functional component
  enhanceApp({ app, router, siteData }) {
    // app is the Vue 3 app instance from createApp()
    // router is VitePress' custom router (see `lib/app/router.js`)
    // siteData is a ref of current site-level metadata.
    // 註冊全局組件
  },
  // 自定義佈局配置
  Layout: () => {
    return h(DefaultTheme.Layout, props, {
      // 自定義文檔底部,使用doc-after插槽
      "doc-after": () => h(siteFooter),
    });
  },
};

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 大家好,我是大彬~ 今天跟大家分享知識星球小伙伴關於【非科班轉碼如何補基礎】的提問。 往期星球提問整理: 讀博?找工作? 性格測試真的很重要 想找一份實習工作,需要準備什麼 球友提問: 大彬大佬,想問下非科班要補哪些基礎? 求推薦視頻,國內國外都行。 大彬的回答: 你好,我也是非科班轉碼的,Java ...
  • ARP (Address Resolution Protocol,地址解析協議),是一種用於將 `IP` 地址轉換為物理地址(`MAC地址`)的協議。它在 `TCP/IP` 協議棧中處於鏈路層,為了在區域網中能夠正確傳輸數據包而設計,由協議數據單元和對應的操作命令組成。`ARP` 既可以由操作系統處... ...
  • aspnetcore微服務之間通信grpc,一般服務對外介面用restful架構,HTTP請求,服務之間的通信grpc多走內網。 以前寫過一篇grpc和web前端之間的通訊,代碼如下: exercisebook/grpc/grpc-web at main · liuzhixin405/exercis ...
  • 正則表達式是一種用來匹配字元串的規則。每個字元在正則表達式中都有其特定的含義,下麵是一些常見的字元及其含義: 1. ^:匹配字元串的開頭位置。 2. $:匹配字元串的結尾位置。 3. .:匹配任意單個字元。 4. *:匹配0個或多個前面的字元。 5. +:匹配1個或多個前面的字元。 6. ?:匹配0 ...
  • 在我們開發的前端項目中,往往為了方便,都需對一些控制項進行自定義的處理,以便實現快速的數據綁定以及便捷的使用,本篇隨筆介紹通過抽取常見字典列表,實現通用的字典類型綁定;以及通過自定義控制項的屬性處理,實現系統字典內容的快捷綁定的操作。 ...
  • 安裝Ubuntu Linux元信息 兩台機器,每台機器兩台Ubuntu Ubuntu版本:ubuntu-22.04.3-desktop-amd64.iso 處理器數量2,每個處理器的核心數量2,總處理器核心數量4 單個虛擬機記憶體8192MB(8G),最大磁碟大小30G 參考鏈接 清華大學開源軟體鏡像 ...
  • 公司有一個新需求,在原來項目基礎上開發,項目中使用 Ant Design Vue,版本是 1.X ,在此記錄下遇到的問題;對於沒有使用過或者使用程度不深的同學來說,希望可以幫助你在開發中遇到問題時有個參考。對於已經熟練使用的同學,可能這些問題都遇到過,歡迎大家在評論區補充。 1、實現對下拉框顯示的所 ...
  • 這是我用於複習我一年前學習的JavaScript的筆記,由於一年過去了,我大概已經4~5個月沒有寫過什麼代碼,所以需要整理自己的知識體系,如果文章出錯,也希望大家評論給我改錯 JavaScript的類型 JS中的類型有以下幾種: Number(數字類型) BigInt (大數類型) String(字 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...