Skip to content

Commit ecd580c

Browse files
committed
highlight {javascript}
1 parent fe09102 commit ecd580c

File tree

2 files changed

+77
-45
lines changed

2 files changed

+77
-45
lines changed

docs/README.gist.md

Lines changed: 38 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Node.js SDK 主要包含对七牛云存储API的包装,遵循[qiniu sdkspec](h
9494

9595
对于服务端而言,常规程序流程是:
9696

97-
```
97+
```{javascript}
9898
@gist(gist/server.js#init)
9999
```
100100

@@ -138,7 +138,7 @@ Node.js SDK 主要包含对七牛云存储API的包装,遵循[qiniu sdkspec](h
138138

139139
[uptoken](http://docs.qiniu.com/api/put.html#uploadToken) 实际上是用 AccessKey/SecretKey 进行数字签名的上传策略(`rs.PutPolicy`),它控制则整个上传流程的行为。让我们快速过一遍你都能够决策啥:
140140

141-
```
141+
```{javascript}
142142
@gist(../qiniu/rs.js#PutPolicy)
143143
```
144144

@@ -158,7 +158,7 @@ Node.js SDK 主要包含对七牛云存储API的包装,遵循[qiniu sdkspec](h
158158

159159
服务端生成 [uptoken](http://docs.qiniu.com/api/put.html#uploadToken) 代码如下:
160160

161-
```
161+
```{javascript}
162162
@gist(gist/server.js#uptoken)
163163
```
164164

@@ -170,7 +170,8 @@ Node.js SDK 主要包含对七牛云存储API的包装,遵循[qiniu sdkspec](h
170170

171171
<a name="upload-do"></a>
172172
PutExtra是上传时的可选信息,默认为null
173-
```
173+
174+
```{javascript}
174175
@gist(../qiniu/io.js#PutExtra)
175176
```
176177

@@ -187,13 +188,14 @@ PutExtra是上传时的可选信息,默认为null
187188
上传文件到七牛(通常是客户端完成,但也可以发生在服务端):
188189

189190
直接上传二进制流:
190-
```
191+
192+
```{javascript}
191193
@gist(gist/client.js#uploadBuf)
192194
```
193195

194196
上传本地文件:
195197

196-
```
198+
```{javascript}
197199
@gist(gist/client.js#uploadFile)
198200
```
199201

@@ -221,7 +223,7 @@ PutExtra是上传时的可选信息,默认为null
221223

222224
其中 dntoken 是由业务服务器签发的一个[临时下载授权凭证](http://docs.qiniu.com/api/get.html#download-token),deadline 是 dntoken 的有效期。dntoken不需要单独生成,SDK 提供了生成完整 downloadUrl 的方法(包含了 dntoken),示例代码如下:
223225

224-
```
226+
```{javascript}
225227
@gist(gist/server.js#downloadUrl)
226228
```
227229

@@ -240,7 +242,8 @@ PutExtra是上传时的可选信息,默认为null
240242
### 资源操作
241243

242244
资源操作限在服务端操作,先进行初始化
243-
```
245+
246+
```{javascript}
244247
@gist(gist/rs.js#init)
245248
```
246249

@@ -249,29 +252,28 @@ PutExtra是上传时的可选信息,默认为null
249252
#### 获取文件信息
250253

251254
<a获取文件信息说明\>
252-
```
255+
256+
```{javascript}
253257
@gist(gist/rs.js#stat)
254258
```
255259

256260
<a name="rs-delete"></a>
257261

258262
#### 删除文件
259263

260-
<a删除文件说明\>
261-
```
264+
```{javascript}
262265
@gist(gist/rs.js#remove)
263266
```
264267

265268
<a name="rs-copy-move"></a>
266269

267270
#### 复制/移动文件
268271

269-
<a复制移动文件说明\>
270-
```
272+
```{javascript}
271273
@gist(gist/rs.js#copy)
272274
```
273275

274-
```
276+
```{javascript}
275277
@gist(gist/rs.js#move)
276278
```
277279

@@ -282,19 +284,26 @@ PutExtra是上传时的可选信息,默认为null
282284
当您需要一次性进行多个操作时, 可以使用批量操作。
283285

284286
####批量获取文件信息
285-
```
287+
288+
```{javascript}
286289
@gist(gist/rs.js#batchStat)
287290
```
291+
288292
####批量复制文件
289-
```
293+
294+
```{javascript}
290295
@gist(gist/rs.js#batchCopy)
291296
```
297+
292298
####批量移动文件
293-
```
299+
300+
```{javascript}
294301
@gist(gist/rs.js#batchMove)
295302
```
303+
296304
####批量删除文件
297-
```
305+
306+
```{javascript}
298307
@gist(gist/rs.js#batchDelete)
299308
```
300309

@@ -305,24 +314,31 @@ PutExtra是上传时的可选信息,默认为null
305314
<a高级管理操作\>
306315
####列出文件
307316
请求某个存储空间(bucket)下的文件列表,如果有前缀,可以按前缀(prefix)进行过滤;第一次调用时置marker为null,之后的调用填上服务器返回的marker(如果有),则列出刚刚为列完的文件
308-
```
317+
318+
```{javascript}
309319
@gist(gist/rsf.js#listPrefix)
310320
```
321+
311322
<a name="fop"></a>
312323

313324
### 云处理
314325

315326
<a云处理使用说明\>
316327
####查看图像信息
317-
```
328+
329+
```{javascript}
318330
@gist(gist/fop.js#makeImageInfoUrl)
319331
```
332+
320333
####查看图像Exif
321-
```
334+
335+
```{javascript}
322336
@gist(gist/fop.js#makeExifUrl)
323337
```
338+
324339
####生成缩略图
325-
```
340+
341+
```{javascript}
326342
@gist(gist/fop.js#makeImageViewUrl)
327343
```
328344

docs/README.md

Lines changed: 39 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Node.js SDK 主要包含对七牛云存储API的包装,遵循[qiniu sdkspec](h
9494

9595
对于服务端而言,常规程序流程是:
9696

97-
```
97+
```{javascript}
9898
qiniu.conf.ACCESS_KEY = '<Your Access Key>'
9999
qiniu.conf.SECRET_KEY = '<Your Secret Key>'
100100
```
@@ -139,10 +139,10 @@ qiniu.conf.SECRET_KEY = '<Your Secret Key>'
139139

140140
[uptoken](http://docs.qiniu.com/api/put.html#uploadToken) 实际上是用 AccessKey/SecretKey 进行数字签名的上传策略(`rs.PutPolicy`),它控制则整个上传流程的行为。让我们快速过一遍你都能够决策啥:
141141

142-
```
142+
```{javascript}
143143
function PutPolicy(scope, callbackUrl, callbackBody, returnUrl, returnBody,
144144
asyncOps, endUser, expires) {
145-
this.scope = scope || null; // 必须
145+
this.scope = scope || null;
146146
this.callbackUrl = callbackUrl || null;
147147
this.callbackBody = callbackBody || null;
148148
this.returnUrl = returnUrl || null;
@@ -169,7 +169,7 @@ function PutPolicy(scope, callbackUrl, callbackBody, returnUrl, returnBody,
169169

170170
服务端生成 [uptoken](http://docs.qiniu.com/api/put.html#uploadToken) 代码如下:
171171

172-
```
172+
```{javascript}
173173
function uptoken(bucketname) {
174174
var putPolicy = new qiniu.rs.PutPolicy(bucketname);
175175
//putPolicy.callbackUrl = callbackUrl;
@@ -191,7 +191,8 @@ function uptoken(bucketname) {
191191

192192
<a name="upload-do"></a>
193193
PutExtra是上传时的可选信息,默认为null
194-
```
194+
195+
```{javascript}
195196
function PutExtra(params, mimeType, crc32, checkCrc) {
196197
this.paras = params || {};
197198
this.mimeType = mimeType || null;
@@ -213,7 +214,8 @@ function PutExtra(params, mimeType, crc32, checkCrc) {
213214
上传文件到七牛(通常是客户端完成,但也可以发生在服务端):
214215

215216
直接上传二进制流:
216-
```
217+
218+
```{javascript}
217219
function uploadBuf(body, key, uptoken) {
218220
var extra = new qiniu.io.PutExtra();
219221
//extra.params = params;
@@ -236,7 +238,7 @@ function uploadBuf(body, key, uptoken) {
236238

237239
上传本地文件:
238240

239-
```
241+
```{javascript}
240242
function uploadFile(localFile, key, uptoken) {
241243
var extra = new qiniu.io.PutExtra();
242244
//extra.params = params;
@@ -281,7 +283,7 @@ function uploadFile(localFile, key, uptoken) {
281283

282284
其中 dntoken 是由业务服务器签发的一个[临时下载授权凭证](http://docs.qiniu.com/api/get.html#download-token),deadline 是 dntoken 的有效期。dntoken不需要单独生成,SDK 提供了生成完整 downloadUrl 的方法(包含了 dntoken),示例代码如下:
283285

284-
```
286+
```{javascript}
285287
function downloadUrl(domain, key) {
286288
var baseUrl = rs.makeBaseUrl(domain, key);
287289
var policy = new rs.GetPolicy();
@@ -304,7 +306,8 @@ function downloadUrl(domain, key) {
304306
### 资源操作
305307

306308
资源操作限在服务端操作,先进行初始化
307-
```
309+
310+
```{javascript}
308311
qiniu.conf.ACCESS_KEY = '<Your Access Key>';
309312
qiniu.conf.SECRET_KEY = '<Your Secret Key>';
310313
```
@@ -314,7 +317,8 @@ qiniu.conf.SECRET_KEY = '<Your Secret Key>';
314317
#### 获取文件信息
315318

316319
<a获取文件信息说明\>
317-
```
320+
321+
```{javascript}
318322
var client = new qiniu.rs.Client();
319323
client.stat(bucketName, key, function(ret) {
320324
if (ret.code === 200) {
@@ -331,8 +335,7 @@ client.stat(bucketName, key, function(ret) {
331335

332336
#### 删除文件
333337

334-
<a删除文件说明\>
335-
```
338+
```{javascript}
336339
var client = new qiniu.rs.Client();
337340
client.remove(bucketName, key, function(ret) {
338341
if (ret.code === 200) {
@@ -348,8 +351,7 @@ client.remove(bucketName, key, function(ret) {
348351

349352
#### 复制/移动文件
350353

351-
<a复制移动文件说明\>
352-
```
354+
```{javascript}
353355
var client = new qiniu.rs.Client();
354356
client.copy(bucketSrc, keySrc, bucketDestm keyDest, function(ret) {
355357
if (ret.code === 200) {
@@ -361,7 +363,7 @@ client.copy(bucketSrc, keySrc, bucketDestm keyDest, function(ret) {
361363
});
362364
```
363365

364-
```
366+
```{javascript}
365367
var client = new qiniu.rs.Client();
366368
client.move(bucketSrc, keySrc, bucketDestm keyDest, function(ret) {
367369
if (ret.code === 200) {
@@ -380,7 +382,8 @@ client.move(bucketSrc, keySrc, bucketDestm keyDest, function(ret) {
380382
当您需要一次性进行多个操作时, 可以使用批量操作。
381383

382384
####批量获取文件信息
383-
```
385+
386+
```{javascript}
384387
var path0 = new qiniu.rs.EntryPath(bucketName, key0);
385388
var path1 = new qiniu.rs.EntryPath(bucketName, key1);
386389
var path2 = new qiniu.rs.EntryPath(bucketName, key2);
@@ -396,8 +399,10 @@ client.batchStat([path0, path1, path2], function(ret) {
396399
}
397400
});
398401
```
402+
399403
####批量复制文件
400-
```
404+
405+
```{javascript}
401406
var pathSrc0 = new qiniu.rs.EntryPath(bucketName, key0);
402407
var pathDest0 = new qiniu.rs.EntryPath(bucketName, key1);
403408
var pathSrc1 = new qiniu.rs.EntryPath(bucketName, key2);
@@ -415,8 +420,10 @@ client.batchCopy([pair0, pair1], function(ret) {
415420
}
416421
});
417422
```
423+
418424
####批量移动文件
419-
```
425+
426+
```{javascript}
420427
var pathSrc0 = new qiniu.rs.EntryPath(bucketName, key0);
421428
var pathDest0 = new qiniu.rs.EntryPath(bucketName, key1);
422429
var pathSrc1 = new qiniu.rs.EntryPath(bucketName, key2);
@@ -434,8 +441,10 @@ client.batchMove([pair0, pair1], function(ret) {
434441
}
435442
});
436443
```
444+
437445
####批量删除文件
438-
```
446+
447+
```{javascript}
439448
var path0 = new qiniu.rs.EntryPath(bucketName, key0);
440449
var path1 = new qiniu.rs.EntryPath(bucketName, key1);
441450
var path2 = new qiniu.rs.EntryPath(bucketName, key2);
@@ -458,7 +467,8 @@ client.batchDelete([path0, path1, path2], function(ret) {
458467
<a高级管理操作\>
459468
####列出文件
460469
请求某个存储空间(bucket)下的文件列表,如果有前缀,可以按前缀(prefix)进行过滤;第一次调用时置marker为null,之后的调用填上服务器返回的marker(如果有),则列出刚刚为列完的文件
461-
```
470+
471+
```{javascript}
462472
qiniu.conf.ACCESS_KEY = '<Your Access Key>';
463473
qiniu.conf.SECRET_KEY = '<Your Secret Key>';
464474
@@ -471,13 +481,15 @@ qiniu.rsf.listPrefix(bucketname, prefix, marker, limit, function(ret) {
471481
}
472482
});
473483
```
484+
474485
<a name="fop"></a>
475486

476487
### 云处理
477488

478489
<a云处理使用说明\>
479490
####查看图像信息
480-
```
491+
492+
```{javascript}
481493
// 生成访问图片的url
482494
var url = qiniu.rs.makeBaseUrl(bucketName, key);
483495
@@ -492,8 +504,10 @@ url = policy.makeRequest(url);
492504
493505
console.log('在浏览器输入: ' + url);
494506
```
507+
495508
####查看图像Exif
496-
```
509+
510+
```{javascript}
497511
// 生成访问图片的url
498512
var url = qiniu.rs.makeBaseUrl(bucketName, key);
499513
@@ -508,8 +522,10 @@ url = policy.makeRequest(url);
508522
509523
console.log('在浏览器输入: ' + url);
510524
```
525+
511526
####生成缩略图
512-
```
527+
528+
```{javascript}
513529
// 生成访问图片的url
514530
var url = qiniu.rs.makeBaseUrl(bucketName, key);
515531

0 commit comments

Comments
 (0)