# xdocs

**Repository Path**: xiao-shenghui/xdocs

## Basic Information

- **Project Name**: xdocs
- **Description**: 一个用vitepress搭建的静态博客，这是一个用于存储博客项目的仓库，避免本地文件丢失。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://xiao-shenghui.github.io/xdocs.github.io/
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2023-07-25
- **Last Updated**: 2024-03-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: JavaScript, blog

## README

[English](./README.en.md) | 简体中文

<h1 align="center">XDocs</h1>
<div align="center">
一个打工人的前端技术Blog. 基于尤大大的 <a href="https://vuecomponent.github.io/ant-design-vue/docs/vue/introduce-cn/" target="_blank">Vitepress</a>
</div>


<div align="center">

[![License](https://img.shields.io/npm/l/package.json.svg?style=flat)](https://github.com/xiao-shenghui/xdocs)
[![Personal Blog](https://img.shields.io/badge/Personal-Blog-yellow?style=flat)](https://vitepress.dev/)
[![Support Markdown](https://img.shields.io/badge/Support-Markdown-red?style=flat)](https://vitepress.dev/)
[![Based Vitepress](https://img.shields.io/badge/Based-Vitepress-blue?style=flat)](https://vitepress.dev/)

</div>

- 线上预览: https://xiao-shenghui.github.io/xdocs.github.io/
- Gitee仓库: https://gitee.com/xiao-shenghui/xdocs
- Github仓库: https://github.com/xiao-shenghui/xdocs
- 更新日志: https://gitee.com/xiao-shenghui/xdocs/blob/master/README-log.md

Overview
----

基于 [Vitepress v1.0.0](https://vitepress.dev/)的前端技术文档，[XDocs](https://github.com/xiao-shenghui/xdocs.git) 

![home](./mdImg/home-2.jpg)


导航目录
----
- [x] Javascript -- (H5新增 --> ES6+) -- 完成 ✨✨
- [x] Typescript -- 更新中 🎉🎉
- [x] Vue -- (Vue2 --> Vue3) -- 更新中 🌹🌹
- [x] React -- (JSX --> React18) -- 更新中 👍👍
- [x] 小程序 -- (原生小程序 --> Uniapp) -- 更新中 👍👍
- [x] 业务场景 -- (文件上传, 瀑布流) -- 更新中 ✨✨
- [x] 工具库 -- (Axios ---> Nodejs) -- 更新中 ✨✨
- [x] 杂七杂八 -- (Gitee ---> Npm包推荐) -- 更新中 ✨✨
- [x] 源码解析 -- Vue2 -- 更新中👍👍


环境和依赖
----
- node
- npm/cnpm
- vsCode
- markdown

> vitepress优势: `vite`工具搭建, 热更新快, markdown编译, 自带代码高亮, 日夜模式, 配置简单, 主题配置.



项目下载和运行
----

- 拉取博客代码
```bash
git clone https://gitee.com/xiao-shenghui/xdocs
cd xdocs
```

- 开发模式运行
```bash
npm start 
#或者
npm run docs:dev
```

- 编译打包项目: 
```bash
npm run docs:build
```
>具体编译请参考vitepress编译. [Build](https://vitepress.dev/reference/site-config#build)


写在最后
----
- 学习的本质是`输入与输出`。   
- 在初次了解`费曼学习法`时，深感认同且一直被其影响，因此创立了`XDocs`用于记录。
搭建博客时使用过`Hexo`，`Vuepress`和`Wrodpress`等静态博客搭建工具，曾经有过一版`Vuepress`的`XDocs`, 但大都没有积累和坚持下去。
- 在了解到`Vue3及Vite`后，接触到`Vitepress`这个非常优秀的搭建工具, 并决定将其作为最终的方案。

> 某种程度上，我准备将`XDocs`可以作为存储知识的`第二仓库`，并分享给一起进步和学习的伙伴。  
> 如果对您有帮助🌹，您可以点右上角 `Star` 支持一下 谢谢！ ^_^