Skip to content

One-click generation of documentation website 一键生成文档网站

Notifications You must be signed in to change notification settings

yaronzz/easy-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ENGLISH | 中文文档

Easy-Docs

One-click generation of documentation website

📺 Install

Python version >= 3.7

pip3 install easy-docs --upgrade

🤖 Features

  • Generate and update documentation catalogs
  • Generate docsify index page

💽 UI

Python-100-Days

image-20220411100211300

🎄Use

cd to the directory of documents.

  1. Initialize the document
easy-docs -i 
  1. Test
easy-docs -s
  1. Update documentation catalogs
easy-docs -u

#does not contain the tmp directory
easy-docs -u -r ./tmp/
  1. Modify documentation pages

    Open index.html,and modify the configuration according to the 【documentation](https://docsify.js.org/#/configuration).

About

One-click generation of documentation website 一键生成文档网站

Resources

Stars

Watchers

Forks

Languages