# Docsite

**Repository Path**: zhang_qing_tao/Docsite

## Basic Information

- **Project Name**: Docsite
- **Description**: Docsite docsite 是一款开源站点搭建工具，依据其提供的功能，能够快速搭建一个开源站点
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/docsite
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 16
- **Created**: 2021-10-08
- **Last Updated**: 2021-10-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

![LOGO](https://img.alicdn.com/tfs/TB1YGpBHxjaK1RjSZFAXXbdLFXa-254-50.png)

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[![Backers on Open Collective](https://opencollective.com/docsite/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/docsite/sponsors/badge.svg)](#sponsors) 

[npm-image]: https://img.shields.io/npm/v/docsite.svg?style=flat-square
[npm-url]: https://npmjs.org/package/docsite
[travis-image]: https://img.shields.io/travis/txd-team/docsite.svg?style=flat-square
[travis-url]: https://travis-ci.org/txd-team/docsite
[codecov-image]: https://codecov.io/gh/txd-team/docsite/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/txd-team/docsite
[david-image]: https://img.shields.io/david/txd-team/docsite.svg?style=flat-square
[david-url]: https://david-dm.org/txd-team/docsite
[snyk-image]: https://snyk.io/test/npm/docsite/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/docsite
[download-image]: https://img.shields.io/npm/dm/docsite.svg?style=flat-square
[download-url]: https://npmjs.org/package/docsite

# Docsite

Docsite is an opensource generator for building an static website, and you can init a website in a few minutes by it.

## Feature

- Be able to generate document, blog, and custom page
- Support markdown files
- Responsive UI
- Good for SEO 
- Support internationalization
- Support custom page

## Document

- [Quick Start](https://docsite.js.org/en-us/docs/installation.html)
- [中文说明](./README_zh.md)

## User

[![Dubbo](https://gw.alicdn.com/tfs/TB17zlswBjTBKNjSZFuXXb0HFXa-300-64.png)](https://dubbo.incubator.apache.org/en-us/)

[![Nacos](https://gw.alicdn.com/tfs/TB1SxFhwpooBKNjSZFPXXXa2XXa-300-64.png)](https://nacos.io/en-us/)

[![AiMatrix](https://img.alicdn.com/tfs/TB1FQFVw8jTBKNjSZFwXXcG4XXa-300-64.jpg)](https://aimatrix.ai)

[![WHARFOO](https://wharfoo.github.io/img/wharfoo_blue.png)](https://wharfoo.github.io)

[![Alibaba Infra](https://img.alicdn.com/tfs/TB1F579nxjaK1RjSZFAXXbdLFXa-366-46.png)](http://www.alibabainfra.org)

[![Sentinel](https://sentinelguard.io/img/sentinel_colorful.png)](https://sentinelguard.io)

[![Dragonfly](https://img.alicdn.com/tfs/TB1ThlOucfpK1RjSZFOXXa6nFXa-266-72.png)](https://d7y.io)

[![TX-LCN](http://www.txlcn.org/img/txlcn.png)](http://www.txlcn.org)

[![SEATA](http://img.alicdn.com/tfs/TB1gqL1w4D1gK0jSZFyXXciOVXa-1497-401.png)](http://seata.io/)

[![WUHAN2020](https://community.wuhan2020.org.cn/images/wuhan2020-logo.png)](https://community.wuhan2020.org.cn/)

[![ApiBoot](https://apiboot.minbox.org/img/apiboot-colorful.png)](https://apiboot.minbox.org)

## Dependency

- node.js > 6.x

## Usage

- Install

```
$ npm i -g docsite
```

- Init a project

```
$ cd my-project
$ docsite init

# or
$ docsite init my-project
```

- Local preview


```
$ docsite start
```

- Build

```
$ docsite build
```

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/txd-team/docsite/contributors"><img src="https://opencollective.com/docsite/contributors.svg?width=890&button=false" /></a>


## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsite#backer)]

<a href="https://opencollective.com/docsite#backers" target="_blank"><img src="https://opencollective.com/docsite/backers.svg?width=890"></a>


## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/docsite#sponsor)]

<a href="https://opencollective.com/docsite/sponsor/0/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/docsite/sponsor/1/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/docsite/sponsor/2/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/docsite/sponsor/3/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/docsite/sponsor/4/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/docsite/sponsor/5/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/docsite/sponsor/6/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/docsite/sponsor/7/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/docsite/sponsor/8/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/docsite/sponsor/9/website" target="_blank"><img src="https://opencollective.com/docsite/sponsor/9/avatar.svg"></a>