# jf-docsify

**Repository Path**: xmcwr/jf-docsify

## Basic Information

- **Project Name**: jf-docsify
- **Description**: 基于docsicfy 与 jfinal 实现的文档管理系统
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 4
- **Created**: 2022-08-08
- **Last Updated**: 2024-04-25

## Categories & Tags

**Categories**: doc-tools

**Tags**: None

## README

## jf-docsify

> 基于docsicfy 与 jfinal 实现的文档管理系统
>
> 主要实现多文档预览， 通过git 管理/更新文档(master 分支)

#### 快速体验

下载项目后， 在项目目录下 执行 mvn package, 然后进入 target\jf-docsify-release\jf-docsify 中执行--》start.bat（window系统），若是linux 系统则执行 ./jfDocsify.sh start，即可快速启动项目，浏览器输入：http://127.0.0.1:8880/admin/index 用户名密码：admin/1234

#### 截图

![](./docs/images/1.png) 

![](./docs/images/2.png) 

![](./docs/images/3.png) 

![](./docs/images/4.png) 

![](./docs/images/5.png) 



#### 配置

1. config.properties

   ```properties
   # 数据库配置
   # 数据库类型 mysql 、sqlite
   docsify.db.type=sqlite
   db.init.showSql=true
   #docsify.db.url=jdbc:mysql://127.0.0.1:3306/docsify?useUnicode=true&characterEncoding=utf-8&useSSL=false
   #docsify.db.username=root
   #docsify.db.password=1234
   
   # 数据库驱动 mysql: com.mysql.jdbc.Driver, sqllite: org.sqlite.JDBC
   docsify.db.url=jfDocsify.db
   docsify.db.username=root
   docsify.db.password=1234
   
   # 应用初始化配置
   # 默认用户名
   app.init.username=jfDocsify
   app.init.baseFolder=/home/data/applications/works/jfDocsify
   ```

2. undertow.txt

   ```properties
   # true 值支持热加载
   undertow.devMode=true
   undertow.port=8880
   undertow.host=0.0.0.0
   ```

#### 库表自动生成

> 若 config.properties 中 docsify.db.type 配置为mysql 需先在数据库中， 新建下库
>
> 若是docsify.db.type 配置为sqlite, 则直接启动项目即可



### 本项目涉及到的开源项目：

1. [JFinal](https://gitee.com/jfinal/jfinal) 

   > 基于 Java 语言的极速 WEB + ORM 框架，其核心设计目标是开发迅速、代码量少、学习简单、功能强大、轻量级、易扩展、Restful。在拥有Java语言所有优势的同时再拥有 ruby、python 等动态语言的开发效率！为您节约更多时间，去陪恋人、家人和朋友 ;)

2. [docsify](https://gitee.com/docsifyjs/docsify) 

   > 一个神奇的文档网站生成器