https://github.com/yaoxfly/vitepress-template

Based on vitepress, integrated ts, and other simple configuration, themes, etc., out of the box, write documents.
https://github.com/yaoxfly/vitepress-template

eslint template typescript vitepress

Last synced: 4 days ago
JSON representation

Based on vitepress, integrated ts, and other simple configuration, themes, etc., out of the box, write documents.

• Host: GitHub
• URL: https://github.com/yaoxfly/vitepress-template
• Owner: yaoxfly
• License: mit
• Created: 2022-07-29T09:25:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-21T10:10:21.000Z (5 months ago)
• Last Synced: 2024-08-21T17:02:58.490Z (5 months ago)
• Topics: eslint, template, typescript, vitepress
• Language: JavaScript
• Homepage:
• Size: 970 KB
• Stars: 12
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README-CN.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[English](README.md)  | [中文](README-CN.md)

# vitepress-template 

基于vitepress，集成了Typescript，以及其他简单的配置、主题等，开箱即用，写文档利器

# 基础配置

+  Typescript

+  自动注册全局组件

+  Eslint 

+  自定义主题

> `ESLint` 默认忽略.开头的目录,  在`.eslintignore`中设置 `!docs/.vitepress` 不让忽略`.vitepress`

# 使用

运行

```js

pnpm run dev

```

打包

```js

pnpm run  build

```

预览

```js

pnpm run serve 

or

pnpm run preview // 先执行pnpm run build 再执行 pnpm run serve 

```

> 打包后才能执行预览操作

# demo地址

Ctrl+点击,可新标签页打开

[模板范例在线访问](https://yaoxfly.github.io/vitepress-template-site)