Giter Club home page Giter Club logo

docman-document's Introduction

DocMan 官方文档

DocMan 是一个自由开源的文档站点生成器,它可以让我们优雅、简洁的生成和部署开发文档,API 接口文档,教程,笔记等多种类型的站点。

项目地址

DocMan:Gitee | GitHub

Docman 文档:Gitee | GitHub

尝试一下

你可以将本项目当作一个 DocMan 文档项目的示例,用 DocMan 将本项目生成为文档站点。

进入 DocMan 实例

cd /path-to-docman
npm install

新建 docs 文件夹

mkdir docs

拉取本文档项目

# Gitee
git clone https://gitee.com/monkeyhbd/docman-document.git

# GitHub
git clone https://github.com/monkeyhbd/docman-document.git

编辑 DocMan 根目录下的配置文件 docman.config.json

{
	"inputDir": "./docs/docman-document",

	"outputDir": "./dist",

	"themeDir": "./themes/docman-theme-classic"
}

运行 DocMan 生成文档站点

npm run build

DocMan 将会输出 HTML 文件至发行目录 dist 下。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.