https://github.com/softwaiter/markdown-website
一个多Markdown文件组织展示网站
https://github.com/softwaiter/markdown-website
markdown markdown-to-html
Last synced: 24 days ago
JSON representation
一个多Markdown文件组织展示网站
- Host: GitHub
- URL: https://github.com/softwaiter/markdown-website
- Owner: softwaiter
- License: mit
- Created: 2021-11-02T09:55:14.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-12-15T07:20:16.000Z (over 2 years ago)
- Last Synced: 2025-05-06T22:15:23.775Z (24 days ago)
- Topics: markdown, markdown-to-html
- Language: Vue
- Homepage:
- Size: 15.4 MB
- Stars: 2
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 一个将markdown文件归类展示的网站生成工具
作为程序猿来讲，markdown是大家天天用、时时用的工具。可能用来记录日常的心得、工作的TODO，更有可能是针对某个项目书写的使用手册；但是在使用过程中，发现两个不太方便的地方，一是每个文档都作为一个单独的文件存在，不方便按照分类进行归档打包，二是分发阅读需要工具的支持，不方便普通用户的阅读。
基于以上原因，Markdown-Website通过目录树的形式对markdown文件进行显示；同时，以静态网页的方式进行发布访问，既解决了分类归档的问题，又提供了随时随地方便访问的能力。
## 演示地址
点击打开演示页面
## Project setup
```
npm install
```
### Compiles and hot-reloads for development
```
npm run serve
```
### Compiles and minifies for production
```
npm run build
```
### Run your tests
```
npm run test
```
### Lints and fixes files
```
npm run lint
```