feat: redesign demo pages v1

This commit is contained in:
chenkailing
2026-04-11 00:29:49 +08:00
parent c41c14bf3c
commit bd20546b6d
7 changed files with 1976 additions and 1033 deletions

View File

@@ -52,6 +52,12 @@
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<!-- ========== 文档格式转换 ========== -->
<dependency>

16
server/src/main/bin/dev.sh Executable file
View File

@@ -0,0 +1,16 @@
#!/bin/bash
set -e
ROOT_DIR=$(cd "$(dirname "$0")/../../../.." || exit 1; pwd)
SERVER_DIR="$ROOT_DIR/server"
if [ -n "$JAVA_HOME" ]; then
export PATH="$JAVA_HOME/bin:$PATH"
fi
cd "$SERVER_DIR" || exit 1
mvn spring-boot:run \
-Dspring-boot.run.addResources=true \
-Dspring-boot.run.jvmArguments="-Dfile.encoding=UTF-8 -Dspring.config.location=$SERVER_DIR/src/main/config/application.properties"

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,23 +1,26 @@
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/html">
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>接入说明</title>
<title>kkFileView 接入说明</title>
<link rel="icon" href="./favicon.ico" type="image/x-icon">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=JetBrains+Mono:wght@400;600&family=Space+Grotesk:wght@500;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="bootstrap/css/bootstrap.min.css"/>
<link rel="stylesheet" href="css/theme.css"/>
<link rel="stylesheet" href="css/main-pages.css"/>
<script type="text/javascript" src="js/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="highlight/highlight.min.js"></script>
</head>
<body>
<nav class="navbar navbar-inverse navbar-fixed-top">
<body class="app-shell">
<nav class="site-nav navbar navbar-inverse navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="https://kkview.cn" target='_blank'>kkFileView</a>
<a class="navbar-brand" href="https://kkview.cn" target="_blank">kkFileView</a>
</div>
<ul class="nav navbar-nav">
<li><a href="./index">首页</a></li>
@@ -28,91 +31,224 @@
</div>
</nav>
<div class="container theme-showcase" role="main">
<#-- 接入说明 -->
<div class="page-header">
<h1>接入说明</h1>
本文档针对前端项目接入 kkFileView 的说明,并假设 kkFileView 的服务地址为http://127.0.0.1:8012。
<div class="page-shell">
<div class="container" role="main">
<section class="hero-section release-hero">
<div class="hero-copy">
<span class="eyebrow">Integration Guide</span>
<h1 class="hero-title">5 分钟把 kkFileView 接进你的前端项目。</h1>
<p class="hero-subtitle">
这页不再把所有方案平铺成一长段,而是按场景拆成独立卡片。
默认假设服务地址为 <span class="text-highlight">${baseUrl}</span>。
</p>
<div class="note-row">
<span class="tag brand">HTTP / HTTPS</span>
<span class="tag">FTP</span>
<span class="tag highlight">AES</span>
<span class="tag warn">附加参数</span>
</div>
<div class="well">
<div class="summary-grid">
<div class="summary-panel">
<strong>URL</strong>
<span>所有预览能力统一汇总到 `onlinePreview` 入口。</span>
</div>
<div class="summary-panel">
<strong>Base64</strong>
<span>普通接入默认对原始文件地址做 Base64 编码后再传入。</span>
</div>
<div class="summary-panel">
<strong>参数扩展</strong>
<span>支持页码、高亮、水印、密码、跨域、AES 和秘钥等控制项。</span>
</div>
</div>
</div>
</section>
<div style="font-size: 16px;">
【http/https 资源文件预览】如果你的项目需要接入文件预览项目达到对docx、excel、ppt、jpg等文件的预览效果那么通过在你的项目中加入下面的代码就可以成功实现
<p style="background-color: #2f332a;color: #cccccc;font-size: 14px;padding:10px;margin-top:10px;">
var url = 'http://127.0.0.1:8080/file/test.txt'; //要预览文件的访问地址 <br>
window.open('${baseUrl}onlinePreview?url='+encodeURIComponent(base64Encode(url)));
</p>
</div>
<br>
<div style="font-size: 16px;">
【http/https 流资源文件预览】很多系统内不是直接暴露文件下载地址而是请求通过id、code等参数到通过统一的接口后端通过id或code等参数定位文件再通过OutputStream输出下载此时下载url是不带文件后缀名的预览时需要拿到文件名传一个参数fullfilename=xxx.xxx来指定文件名示例如下
<p style="background-color: #2f332a;color: #cccccc;font-size: 14px;padding:10px;margin-top:10px;">
var originUrl = 'http://127.0.0.1:8080/filedownload?fileId=1'; //要预览文件的访问地址<br>
var previewUrl = originUrl + '&fullfilename=test.txt'<br>
window.open('${baseUrl}onlinePreview?url='+encodeURIComponent(Base64.encode(previewUrl)));
</p>
</div>
<br>
<div style="font-size: 16px;">
【ftp 资源文件预览】如果要预览的FTP url是可以匿名访问的不需要用户名密码则可以直接通过下载url预览示例如下
<p style="background-color: #2f332a;color: #cccccc;font-size: 14px;padding:10px;margin-top:10px;">
var url = 'ftp://127.0.0.1/file/test.txt'; //要预览文件的访问地址<br>
window.open('${baseUrl}onlinePreview?url='+encodeURIComponent(Base64.encode(url)));
</p>
</div>
<br>
<div style="font-size: 16px;">
【ftp 加密资源文件预览】如果 FTP 需要认证访问服,可以通过在 url 中加入用户名密码等参数预览,示例如下
<p style="background-color: #2f332a;color: #cccccc;font-size: 14px;padding:10px;margin-top:10px;">
var originUrl = 'ftp://127.0.0.1/file/test.txt'; //要预览文件的访问地址<br>
var previewUrl = originUrl + '?ftp.control.port=xx&ftp.username=xx&ftp.password=xx&ftp.control.encoding=(gbk,utf8等)'; //(为了安全强烈建议在配置中设置相关信息)<br>
window.open('${baseUrl}onlinePreview?url='+encodeURIComponent(Base64.encode(previewUrl)));
</p>
</div>
<div style="font-size: 16px;">
【Basic 鉴权资源文件预览】如果需要认证访问服可以通过在url中加入用户名密码等参数预览示例如下
<p style="background-color: #2f332a;color: #cccccc;font-size: 14px;padding:10px;margin-top:10px;">
var originUrl = 'http://127.0.0.1/file/test.txt'; //要预览文件的访问地址<br>
var previewUrl = originUrl + '?basic.name=admin&basic.pass=123456'; //(为了安全强烈建议在配置中设置相关信息)<br>
window.open('${baseUrl}onlinePreview?url='+encodeURIComponent(Base64.encode(previewUrl)));
</p>
</div>
<div style="font-size: 16px;">
AES加密接入方法示例如下
<p style="background-color: #2f332a;color: #cccccc;font-size: 14px;padding:10px;margin-top:10px;">
主要事项首先引入下面js 在把url转换成AES,注意前后端key必须相同注意JS下载到你接入服务器的网址<br>
&lt;script src="${baseUrl}js/crypto-js.js"></script><br>
&lt;script src="${baseUrl}js/aes.js"></script><br>
function aesEncrypt(encryptString, key) { <br>
var key = CryptoJS.enc.Utf8.parse(key); <br>
var srcs = CryptoJS.enc.Utf8.parse(encryptString); <br>
var encrypted = CryptoJS.AES.encrypt(srcs, key, { mode: CryptoJS.mode.ECB, padding: CryptoJS.pad.Pkcs7 }); <br>
return encrypted.toString(); <br>
}<br>
var key = "1234567890123456"; // AES秘钥16位数字<br>
var url = "http://127.0.0.1/file/test.txt";<br>
window.open('${baseUrl}onlinePreview?url='+encodeURIComponent(aesEncrypt(url, key))+'&encryption=aes');
</p>
</div>
<div class="docs-layout">
<aside class="page-toc">
<h3>快速导航</h3>
<ul>
<li><a href="#quick-start">快速开始</a></li>
<li><a href="#http-preview">HTTP 文件预览</a></li>
<li><a href="#stream-preview">流式接口预览</a></li>
<li><a href="#ftp-preview">FTP 预览</a></li>
<li><a href="#basic-auth">Basic 鉴权</a></li>
<li><a href="#aes-preview">AES 加密</a></li>
<li><a href="#extra-params">附加参数</a></li>
</ul>
</aside>
<div style="font-size: 16px;">
其他参数示例如下
<p style="background-color: #2f332a;color: #cccccc;font-size: 14px;padding:10px;margin-top:10px;">
密码参数&filePassword=加密文件的密码<br>
页码参数&page=选择第几页预览<br>
高亮参数&highlightall=关键字 突出显示 <br>
水印参数&watermarkTxt=你的水印<br>
重生参数&forceUpdatedCache=true <br>
跨域参数&kkagent=true <br>
加密缓存&usePasswordCache=true <br>
秘钥参数&key= 访问秘钥 <br>
主要事项以上参数是把url转换成base64后面在添加<br>
var url = 'http://127.0.0.1:8080/file/test.txt'<br>
window.open('${baseUrl}onlinePreview?url='+encodeURIComponent(base64Encode(url))+'&filePassword=123&page=1&highlightall=kkfileview&watermarkTxt=kkfileview&kkagent=false&key=123');
</p>
<div class="docs-content">
<section class="doc-card" id="quick-start">
<div class="doc-card-header">
<div>
<span class="eyebrow">Quick Start</span>
<h3>接入思路</h3>
</div>
<div class="tags">
<span class="tag brand">推荐入口</span>
</div>
</div>
<p>前端只需要拿到可访问的文件 URL然后把它编码后拼到 `${baseUrl}onlinePreview` 上即可。对于大多数业务系统,这是最快的落地路径。</p>
<ul>
<li>普通 HTTP/HTTPS 文件地址:直接 Base64 编码后传入。</li>
<li>下载流接口没有后缀名:补充 `fullfilename=xxx.xxx`。</li>
<li>鉴权或加密场景:附加 Basic、FTP、AES 等参数。</li>
</ul>
</section>
<section class="doc-card" id="http-preview">
<div class="doc-card-header">
<div>
<span class="eyebrow">HTTP / HTTPS</span>
<h3>普通文件地址预览</h3>
</div>
<button class="copy-btn" type="button" onclick="copyCode(this)">复制代码</button>
</div>
<p>适用于系统已经直接暴露出可下载文件地址的情况。前端只需要编码后打开新窗口。</p>
<div class="code-block">
<code class="language-javascript">var url = 'http://127.0.0.1:8080/file/test.txt';
window.open('${baseUrl}onlinePreview?url=' + encodeURIComponent(base64Encode(url)));</code>
</div>
</section>
<section class="doc-card" id="stream-preview">
<div class="doc-card-header">
<div>
<span class="eyebrow">Streaming</span>
<h3>流式接口预览</h3>
</div>
<button class="copy-btn" type="button" onclick="copyCode(this)">复制代码</button>
</div>
<p>很多业务系统通过 `fileId`、`code` 等参数走统一下载接口,此时原始 URL 没有后缀名,需要额外指定完整文件名。</p>
<div class="code-block">
<code class="language-javascript">var originUrl = 'http://127.0.0.1:8080/filedownload?fileId=1';
var previewUrl = originUrl + '&amp;fullfilename=test.txt';
window.open('${baseUrl}onlinePreview?url=' + encodeURIComponent(Base64.encode(previewUrl)));</code>
</div>
</section>
<section class="doc-card" id="ftp-preview">
<div class="doc-card-header">
<div>
<span class="eyebrow">FTP</span>
<h3>FTP 资源预览</h3>
</div>
<button class="copy-btn" type="button" onclick="copyCode(this)">复制代码</button>
</div>
<p>FTP 如果允许匿名访问,可以直接预览;如果需要认证,则把连接参数拼到 URL 后面传入。</p>
<div class="code-block">
<code class="language-javascript">// 匿名 FTP
var url = 'ftp://127.0.0.1/file/test.txt';
window.open('${baseUrl}onlinePreview?url=' + encodeURIComponent(Base64.encode(url)));
// 认证 FTP
var originUrl = 'ftp://127.0.0.1/file/test.txt';
var previewUrl = originUrl + '?ftp.control.port=21&amp;ftp.username=admin&amp;ftp.password=123456&amp;ftp.control.encoding=utf8';
window.open('${baseUrl}onlinePreview?url=' + encodeURIComponent(Base64.encode(previewUrl)));</code>
</div>
</section>
<section class="doc-card" id="basic-auth">
<div class="doc-card-header">
<div>
<span class="eyebrow">Basic Auth</span>
<h3>带 Basic 鉴权的 HTTP 资源</h3>
</div>
<button class="copy-btn" type="button" onclick="copyCode(this)">复制代码</button>
</div>
<p>如果文件源本身需要用户名和密码,可以直接把 Basic 鉴权参数拼到地址中,再交给 kkFileView。</p>
<div class="code-block">
<code class="language-javascript">var originUrl = 'http://127.0.0.1/file/test.txt';
var previewUrl = originUrl + '?basic.name=admin&amp;basic.pass=123456';
window.open('${baseUrl}onlinePreview?url=' + encodeURIComponent(Base64.encode(previewUrl)));</code>
</div>
</section>
<section class="doc-card" id="aes-preview">
<div class="doc-card-header">
<div>
<span class="eyebrow">AES</span>
<h3>前后端同秘钥加密接入</h3>
</div>
<button class="copy-btn" type="button" onclick="copyCode(this)">复制代码</button>
</div>
<p>如果不希望明文传递原始文件地址,可以在前端先做 AES 加密,再通过 `encryption=aes` 告知服务端按 AES 方式解密。</p>
<div class="code-block">
<code class="language-javascript">&lt;script src="${baseUrl}js/crypto-js.js"&gt;&lt;/script&gt;
&lt;script src="${baseUrl}js/aes.js"&gt;&lt;/script&gt;
function aesEncrypt(encryptString, key) {
var keyBytes = CryptoJS.enc.Utf8.parse(key);
var srcs = CryptoJS.enc.Utf8.parse(encryptString);
var encrypted = CryptoJS.AES.encrypt(srcs, keyBytes, {
mode: CryptoJS.mode.ECB,
padding: CryptoJS.pad.Pkcs7
});
return encrypted.toString();
}
var key = '1234567890123456';
var url = 'http://127.0.0.1/file/test.txt';
window.open('${baseUrl}onlinePreview?url=' + encodeURIComponent(aesEncrypt(url, key)) + '&amp;encryption=aes');</code>
</div>
</section>
<section class="doc-card" id="extra-params">
<div class="doc-card-header">
<div>
<span class="eyebrow">Parameters</span>
<h3>常用附加参数</h3>
</div>
<button class="copy-btn" type="button" onclick="copyCode(this)">复制代码</button>
</div>
<p>这些参数都应该在原始 URL 编码完成之后,再附加到预览地址后面。</p>
<ul>
<li>`filePassword`:加密文件的密码。</li>
<li>`page`:指定预览页码。</li>
<li>`highlightall`:关键字高亮。</li>
<li>`watermarkTxt`:动态水印文本。</li>
<li>`forceUpdatedCache=true`:强制刷新缓存。</li>
<li>`kkagent=true`:需要 kkFileView 代理跨域时启用。</li>
<li>`usePasswordCache=true`:开启密码缓存。</li>
<li>`key`:实例启用秘钥后传入访问秘钥。</li>
</ul>
<div class="code-block">
<code class="language-javascript">var url = 'http://127.0.0.1:8080/file/test.txt';
window.open(
'${baseUrl}onlinePreview?url=' +
encodeURIComponent(base64Encode(url)) +
'&amp;filePassword=123' +
'&amp;page=1' +
'&amp;highlightall=kkfileview' +
'&amp;watermarkTxt=kkfileview' +
'&amp;kkagent=false' +
'&amp;key=123'
);</code>
</div>
</section>
</div>
</div>
</div>
</div>
<script>
if (window.hljs) {
document.querySelectorAll('.code-block code').forEach(function (block) {
hljs.highlightBlock(block);
});
}
function copyCode(button) {
var code = button.parentNode.parentNode.querySelector('code').innerText;
var originalText = button.textContent;
navigator.clipboard.writeText(code).then(function () {
button.textContent = '已复制';
setTimeout(function () {
button.textContent = originalText;
}, 1500);
});
}
</script>
</body>
</html>

File diff suppressed because it is too large Load Diff

View File

@@ -1,24 +1,25 @@
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/html">
<html lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>赞助开源</title>
<title>kkFileView 赞助开源</title>
<link rel="icon" href="./favicon.ico" type="image/x-icon">
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=JetBrains+Mono:wght@400;600&family=Space+Grotesk:wght@500;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="bootstrap/css/bootstrap.min.css"/>
<link rel="stylesheet" href="css/theme.css"/>
<link rel="stylesheet" href="css/main-pages.css"/>
<script type="text/javascript" src="js/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="bootstrap/js/bootstrap.min.js"></script>
</head>
<body>
<!-- Fixed navbar -->
<nav class="navbar navbar-inverse navbar-fixed-top">
<body class="app-shell">
<nav class="site-nav navbar navbar-inverse navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="https://kkview.cn" target='_blank'>kkFileView</a>
<a class="navbar-brand" href="https://kkview.cn" target="_blank">kkFileView</a>
</div>
<ul class="nav navbar-nav">
<li><a href="./index">首页</a></li>
@@ -29,44 +30,97 @@
</div>
</nav>
<div class="container theme-showcase" role="main">
<#-- 接入说明 -->
<div class="page-header">
<h1>赞助开源</h1>
<ul style="font-size: 16px;">
<li>kkFileView 开源至今已 6 个年头,积累 <a target="_blank" href="https://gitee.com/kekingcn/file-online-preview">Gitee(16.9K)</a>、<a target="_blank" href="https://github.com/kekingcn/kkFileView">GitHub(8k)</a> 多的 star</li>
<li>kkFileView 被广泛应用于金融教育银行政务计算机等行业, 不完全统计有 200+ 企业在使用</li>
<li>kkFileView 每年的文档站点演示站点的服务器CDN 资源, 至少在 1000元以上</li>
<li>kkFileView 是一款完全开源的在线预览项目如果你觉得 kkFileView 对你有帮助可以通过下面的方式来赞助我们谢谢</li>
<div class="page-shell">
<div class="container" role="main">
<section class="hero-section release-hero">
<div class="hero-copy">
<span class="eyebrow">Sponsor Open Source</span>
<h1 class="hero-title">如果这个项目帮你省下了成本,也欢迎反过来帮它继续跑下去。</h1>
<p class="hero-subtitle">
kkFileView 已持续维护多年,被广泛用于金融、教育、银行、政务和企业内部系统。
赞助会直接用于文档站、演示站、服务器和 CDN 等基础开销。
</p>
<div class="summary-grid">
<div class="summary-panel">
<strong>多年维护</strong>
<span>项目长期迭代,持续补格式、补安全、补性能。</span>
</div>
<div class="summary-panel">
<strong>广泛使用</strong>
<span>不完全统计已有 200+ 企业或团队在使用。</span>
</div>
<div class="summary-panel">
<strong>基础成本</strong>
<span>文档站、演示站和 CDN 等年成本至少在千元级。</span>
</div>
</div>
<div class="note-row">
<span class="tag brand"><a target="_blank" href="https://gitee.com/kekingcn/file-online-preview">Gitee</a></span>
<span class="tag brand"><a target="_blank" href="https://github.com/kekingcn/kkFileView">GitHub</a></span>
<span class="tag highlight">完全开源</span>
</div>
</div>
</section>
<div class="sponsor-grid">
<section class="doc-card">
<div class="doc-card-header">
<div>
<span class="eyebrow">Ways To Sponsor</span>
<h3>赞助方式</h3>
</div>
</div>
<p>如果你觉得 kkFileView 对你有帮助,可以通过下面的方式赞助项目。页面信息会继续保留简洁,但视觉上统一到新的主站风格里。</p>
<ul>
<li>kkFileView 开源至今已多年,社区持续反馈并推动演进。</li>
<li>项目 star 与使用规模已经证明它不是“玩具 demo”而是被真实系统接入的基础能力。</li>
<li>赞助记录为手动录入,存在周级延迟;如有遗漏,可联系作者补录。</li>
</ul>
<div class="donation-wall">
<div class="qr-card">
<h4>支付宝</h4>
<img alt="支付宝赞助码" src="../images/alipay.jpeg"/>
</div>
<div class="qr-card">
<h4>微信支付</h4>
<img alt="微信赞助码" src="../images/wxpay.jpeg"/>
</div>
</div>
</section>
<section class="doc-card">
<div class="doc-card-header">
<div>
<div style="font-size: 16px; text-align: center;">
<img width="400px" height="550px" alt="alipay" src="../images/alipay.jpeg"/> &nbsp;&nbsp;&nbsp;<img width="400px" height="550px" alt="wxpay" src="../images/wxpay.jpeg"/>
</div>
</div>
<div>
<span class="eyebrow">Sponsor Log</span>
<h3>赞助记录</h3>
2023-03-14 开启赞助通道赞助记录为手动录入的存在周级别延迟如有遗漏请联系作者补充
<br/>
<table class="table table-striped table-bordered">
</div>
<div class="tags">
<span class="tag">2023-03-14 开启赞助通道</span>
</div>
</div>
<p>赞助记录为手动维护,如有遗漏,请联系作者补充。</p>
<table class="table sponsor-table">
<thead>
<tr>
<th>赞助人</th>
<th>赞助金额</th>
<th>赞助时间</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td>陈**</td>
<td>99</td>
<td class="sponsor-amount">99</td>
<td>2023-03-14</td>
<td></td>
<td>首批赞助记录</td>
</tr>
</tbody>
</table>
</section>
</div>
</div>
</div>
</body>
</html>