搭建一个vuepress静态网站及配置

news2024/12/29 8:47:16

搭建一个vuepress静态网站及配置

  • 一、搭建一个vuepress网站
    • 1、创建并进入一个新目录
    • 2、初始化
    • 3、安装依赖
    • 4、创建文档
    • 5、配置启动命令及启动
    • 6、展示效果
  • 二、配置及丰富vuepress网站
    • 1、增加配置文件
    • 2、配置侧边栏目录
    • 3、使用部分markdown语法完善页面

一、搭建一个vuepress网站

前提条件:
VuePress 需要 Node.js (opens new window)>= 8.6

1、创建并进入一个新目录

mkdir vuepress-starter && cd vuepress-starter

2、初始化

yarn init 或 npm init

一路回车生成package.json

3、安装依赖

根据项目开发环境安装vuepress依赖

yarn add -D vuepress 或 npm install -D vuepress

注意:
如果你的现有项目依赖了webpack 3.x ,我们推荐使用 Yarn (opens new window)而不是 npm 来安装 VuePress。因为在这种情形下,npm 会生成错误的依赖树。

4、创建文档

mkdir docs && echo # Hello VuePress > docs/README.md

5、配置启动命令及启动

在package.json中配置scripts,可以替换启动命令,如果不配置的话,启动的命令则是npx vuepress dev docs

 "scripts": {
    "dev": "vuepress dev docs",
    "build": "vuepress build docs"
  }

配置过后,启动的命令则是yarn dev或者npm run dev

6、展示效果

第一个vuepress网站

二、配置及丰富vuepress网站

只是搭建一个页面展示静态网站,第一阶段已经实现,但是还想要其他丰富的效果,比如侧边栏目录,页面中的目录,提示等等,那第二阶段尤为重要

1、增加配置文件

vuepress官网中提及了在docs的目录下新增一个.vuepress的文件夹

// 项目结构
├─ docs
│  ├─ README.md
│  └─ .vuepress
│     └─ config.js
└─ package.json

但是直接创建这个名字会提示这样的东西创建文件夹


所以我们需要用一个命令来构建这个文件夹

	npx vuepress build docs

这样就生成了.vuepress的文件夹,文件夹下还有一个dist文件夹,这是一个打包文件夹,然后将这个dist文件夹移动至与docs同级下,在.vuepress文件夹下新建一个config.js,在其中导出一个对象,先配置一些基本的东西

module.exports = {
  title: 'Hello VuePress',
  description: 'Just playing around'
}

对于上述的配置,如果你运行起 dev server,你应该能看到一个页面,它包含一个页头,里面包含一个标题和一个搜索框。VuePress 内置了基于 headers 的搜索 —— 它会自动为所有页面的标题、h2 和 h3 构建起一个简单的搜索索引。

带搜索的vuepress

2、配置侧边栏目录

第一步,在docs文件夹下创建需要展示的文件夹及文件夹下的文件,包括图片文件及展示页面的文件,如下图所示
创建的相关文件夹
第二步,配置config.js生成侧边栏

// 注意: base的值为github仓库的名称
module.exports = {
  base: '/fisrt-vuepress/', /* 基础虚拟路径: */
  dest: 'dist', /* 打包文件基础路径, 在命令所在目录下 */
  title: 'vuePress', // 标题
  description: '搭建一个vuePress', // 标题下的描述
  themeConfig: { // 主题配置
    sidebar: [ // 左侧导航
      {
        title: '认识vuePress', // 标题
        collapsable: false, // 下级列表不可折叠
        children: [ // 下级列表
          ['part1/01_vuepress','第一章'],  //第一个是文件路径,第二个是侧边栏目录文字
          ['part1/02_vuepress','第二章']
        ]
      },
      {
        title: '熟悉vuePress',
        collapsable: false,
        children: [
          ['part2/01_vuepress','第一章'],
          ['part2/02_vuepress','第二章'],
          ['part2/03_vuepress','第三章'],
          ['part2/04_vuepress','第四章'],
          ['part2/05_vuepress','第五章'],
          ['part2/06_vuepress','第六章'],
        ]
      },
    ]
  }
}

生成侧边栏目录

3、使用部分markdown语法完善页面

我们在首页,也就是一开始创建的README.md文件中使用一些markdown语法,使页面更加的美观


# Hello VuePress!

# 目录  
[[toc]]

## 图片
![An image](./image/index.jpg)

## 跳转按钮
[开始学习 →](../part1/01_vuepress.md)

## 提示
### tip
::: tip 提示
这是一个提示
:::

### warning
::: warning 警告
这是一个警告
:::

### danger
::: danger 危险警告
这是一个危险警告
:::

### details
::: details 详情
这是一个详情块,在 IE / Edge 中不生效
:::

这里面的效果包含页面中的目录,图片展示,跳转其他页面及自定义容器等,展示的效果如下图
目录展示
图片及跳转按钮
自定义容器
这些只是部分的markdown语法,如果想让你的页面变得更丰富更美观,可以去vuePress官网继续深入学习

本期文章就到这里,有什么交流的评论区见~

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/592303.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

【Python实战】Python采集热榜数据

前言 大家好,我们今天来爬取热搜榜,把其文章名称,链接和作者获取下来,我们保存到本地,我们通过测试,发现其实很简单,我们只要简单获取数据就可以。没有加密的东西。 效果如下: 环境使用 python 3.9pycharm模块使用 requests模块介绍 requests requests是一个很…

​​​​Linux Shell 实现一键部署Ruby3

ruby Ruby,一种简单快捷的面向对象(面向对象程序设计)脚本语言,在20世纪90年代由日本人松本行弘(Yukihiro Matsumoto)开发,遵守GPL协议和Ruby License。它的灵感与特性来自于 Perl、Smalltalk、Eiffel、Ada以及 Lisp …

【上篇】我们邀请了4位专家来探讨消费市场的新增量:W型机会、单客经济、日本市场、DTC......

好久不见了,我是增长黑盒的创始人yolo。最近我们总是发布一些严肃型的行业报告,相信大家的动作都是在第一时间点个收藏,然后....就没有然后了。 所以,今天我们的内容没有复杂的图表和数据,想用比较轻松的对话形式来呈现…

专业的知识图谱应用门槛正在被不断降低

前⾔ 知识图谱(knowledge graph)⼀度被专家称为“AI皇冠上的明珠”,因为知识图谱技术是⼈⼯智能技术⽅向中的重要⼀环。它不仅可以为其他⼈⼯智能应⽤提供⽀持,如⾃然语⾔处理、推荐系统等,更可以帮助⼈⼯智能系统⾃主…

小程序开发中常见问题解决技巧

众所周知,开发小程序是一件复杂而又繁琐的事情,而且小程序开发也需要一定的技术含量,同时还需要投入大量的时间和精力。所以,在小程序开发过程中,难免会遇到各种各样的问题。为了让大家可以顺利地开发出高质量的小程序…

物联网网关在预付费售电管理系统的构建及应用

摘 要:在社会的不断发展与进步下,信息产业也迎来了自己的繁荣时代,物联网正是在这样的背景之下进入了人们的视野。在互联网的不断发展以及计算机技术的各种进步之下,物联网也迎来了一个又一个的突破,物联网&#xff0c…

契约锁参与第四届【鼎捷智造节】,携手推进制造业数智化转型

如今,制造业正处在智能制造转变的关键期,各类数字化需求不断涌现,为了推动行业数字化转型,鼎捷软件于2021年10月首发启动【鼎捷智造节】,集生态合作圈打造、企业转型赋能、业内优秀产品服务于一体,汇聚业内…

JS的isNAN:判断数字是否合法

定义和用法 isNaN() 函数用于检查其参数是否是非数字值。 如果参数值为 NaN 或字符串、对象、undefined等非数字值则返回 true, 否则返回 false。 语法 isNaN(value) 参数描述value必需。要检测的值。 <!DOCTYPE html> <html lang"en"> <head><…

百万数据导出,居然爆炸了OutOfMemoryError?

一、问题的提出 /*** 大数据导出1.0* /demo/exportExcel4* param response*/ GetMapping("/exportExcel4") public void exportExcel4(HttpServletResponse response) throws IOException {Date start new Date();// 模拟数据List<UserExportVO> users new …

「从零入门推荐系统」19:HM推荐系统代码实战案例

作者 | gongyouliu 编辑 | gongyouliu 我们在上一章中利用Netflix prize数据集讲解了最基础、最简单的一些推荐系统召回、排序算法&#xff0c;大家应该对怎么基于Python实现推荐算法有了一些基本的了解了。接着上一章的思路&#xff0c;本章我们会基于一个更复杂、更近代一点的…

JAVA企业级开发 1.5 初探Spring AOP

一、提出游吟诗人唱赞歌任务 骑士执行任务前和执行任务后&#xff0c;游吟诗人唱赞歌 &#xff08;一&#xff09;采用传统方式实现 修改day04子包的勇敢骑士类 修改day04子包里的救美骑士类 执行测试类 - TestKnight &#xff08;二&#xff09;采用传统方式实现的缺…

Hive部署本地模式

本地模式 使用mysql替换derby进行元数据的存储&#xff0c;hive的相关进程都是在同一台机器上&#xff0c;即本地模式。mysql因为是独立的进程&#xff0c;所以mysql可以和hive在同一机器上&#xff0c;也可以在其他机器上。 说明&#xff1a; 通常使用关系型数据库来进行元数据…

微信公众号、支付接口认证:一步步教您如何实现

1、微信公众号接口认证方案 1.1 认证流程 1&#xff09;官方配置Token验证 Token不在网络中传递 2&#xff09;开发一个Token验证接口 Token及其它参数拼接并字典排序再做sha摘要计算微信定期调用此接口来验证身份正确性通过摘要验证判断请求来源微信&#xff08;Token配置…

TensorFlow进行MNIST数据集手写数字识别,保存模型并且进行外部手写图片测试

首先&#xff0c;你已经配置好Anaconda3的环境&#xff0c;下载了TensorFlow模块&#xff0c;并且会使用jupyter了&#xff0c;那么接下来就是MNIST实验步骤。 数据集官网下载&#xff1a;MNIST handwritten digit database, Yann LeCun, Corinna Cortes and Chris Burgeshttp…

apple pencil的替代品买啥比较好?平价电容笔推荐

随着技术的发展&#xff0c;出现了许多种类的电容笔。一款好的电容笔&#xff0c;不但可以极大地提升我们的工作效率&#xff0c;也可以极大地改善我们的学习效果。平替电容笔无论是在技术方面&#xff0c;还是在产品质量方面&#xff0c;都有着非常广泛的应用前景。下面就是我…

Java领域的序列化与反序列化,Java的对象如何传输,常用序列化技术

文章目录 一、引出问题&#xff1a;Java原生的序列化1、基于Socket传输对象案例2、什么是序列化3、Java 原生序列化4、serialVersionUID 的作用5、transient 关键字绕开 transient 机制的办法writeObject 和 readObject 原理 6、Java 序列化的一些简单总结 二、分布式架构下常见…

【智能座舱系列| AR-HUD增强现实】—AR-HUD到底是“鸡肋”还是“真”香?

AR-HUD 概念 HUD,即抬头显示(Head Up Display),又叫平视显示系统。它的作用,就是把时速、导航等重要的行车信息,投影到驾驶员前面的挡风玻璃上,让驾驶员尽量做到不低头、不转头就能看到。 这种显示系统,原是军用战斗机上的显示系统,飞行员不必低头,就能在挡风玻璃上…

ChatGPT学习笔记;Meta发布Megabyte AI模型抗衡Transformer

AI知识 ChatGPT学习笔记 文章包括如下的内容&#xff1a; ChatGPT 介绍科普 背景知识ChatGPT 功能ChatGPT 原理 等等&#xff0c;文章的地址在这里。 AI新闻 &#x1f680; Meta发布Megabyte AI模型抗衡Transformer&#xff1a;解决后者已知问题、速度提升4成 摘要&…

笔试强训5

作者&#xff1a;爱塔居 专栏&#xff1a;笔试强训 作者简介&#xff1a;大三学生&#xff0c;希望和大家一起进步 目录 day6 day7 day6 1.关于抽象类与最终类&#xff0c;下列说法错误的是&#xff1f; A 抽象类能被继承&#xff0c;最终类只能被实例化。 B 抽象类和最终类…

NET HELPMSG 3534 报错

使用了带管理员权限的 PowerShell&#xff08;即在管理员权限下运行CMD&#xff09; 然后进行安装和服务启动操作 1、清空 MySQL 下的 data 文件夹&#xff1b; 2、确保系统环境变量中已经配置了 mysql 的 bin 目录到Path中&#xff1b; 3、执行以下命令&#xff1a; sc delet…