Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

cldoc

Package Overview
Dependencies
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

cldoc

Example

  • 0.2.4
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4
decreased by-33.33%
Maintainers
1
Weekly downloads
 
Created
Source

一个简单的文档工具

Example repo: https://github.com/ykan/ykan.github.com

Result: http://ykan.github.io/blog/

Install

~ npm install cldoc -g

目录结构

仓库必须包含以下两个目录:

- documents //存放文档
    - common // 类目目录,可以自己新建文件夹
    - README.md //目录的根页面,会被渲染为index.html,比如common/README.md,会生成common/index.html
    - example.md // -> common/example.md.html
    - example.ignore.md //注意:如果字符中包含了ignore,那么这个文件将会再导航中被忽略
  - README.md // -> index.html 生成最外层的根页面
- models // 存放数据模型
  - example.json

使用

~ cldoc <outputDir> #输出文件夹

自定义的标签

http://www.ykan.space/docs/lasted-1.doc-tool-tag.md.html

FAQs

Package last updated on 15 Dec 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc