!LOGO

[![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]

[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
- 中文说明

User












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].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]