Skip to content

Commit 5520e5c

Browse files
author
潘卓然Y7000P
committed
【SDK】【文档】【针对移动端的文档适配进行对应的适配工作】
1 parent d201ca3 commit 5520e5c

22 files changed

Lines changed: 2546 additions & 46 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ MapGIS Client for JavaScript：是增强的MapGIS Web开发平台，集成Openla
1818
- [特性](#特性)
1919
- [示例](#示例)
2020
- [深入了解](#深入了解)
21-
- [代码结构](#代码结构)
21+
- [代码结构](#代码结构)
2222
- [编译](#编译)
2323
- [问题](#问题)
2424
- [依赖](#依赖)

‎docs/cdn/mapgis.css‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,22 @@ body.small-header .top-nav {
2828
margin-top : 8px;
2929
}
3030

31-
.image img {
31+
/* .image img {
3232
display: block;
3333
height : auto;
3434
width : fit-content !important;
35-
}
35+
} */
3636

37-
.mapgis-webclient-logo {
37+
/* .mapgis-webclient-logo {
3838
margin-left: 79px;
3939
height : 38px !important;
40-
}
40+
} */
4141

4242
.logo {
4343
float : left !important;
4444
display: flex !important;
4545
}
4646

4747
#main>.core {
48-
padding: 30px !important;
48+
padding: 6px !important;
4949
}

‎docs/jsdoc-config/cesium/docs.json‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"opts": {
3+
"encoding": "utf8",
4+
"private": false,
5+
"recurse": true,
6+
"lenient": true,
7+
"tutorials": "./docs/jsdoc-config/cesium/tutorials",
8+
"destination": "./website/public/docs/cesium",
9+
"template": "./docs/templates/better-docs"
10+
},
11+
"disqus": "",
12+
"tags": {
13+
"allowUnknownTags": true
14+
},
15+
"source": {
16+
"includePattern": ".+\\.js?$",
17+
"include": ["src/cesiumjs/"],
18+
"exclude": [
19+
"src/cesiumjs/overlay/echarts/",
20+
"src/cesiumjs/overlay/mapv/"
21+
]
22+
},
23+
"plugins": ["plugins/markdown"],
24+
"templates": {
25+
"search": true,
26+
"cleverLinks": true,
27+
"monospaceLinks": true,
28+
"outputSourceFiles": true,
29+
"outputSourcePath": true,
30+
"default": {
31+
"outputSourceFiles": true
32+
},
33+
"better-docs": {
34+
"logo": "../image/mapgis_blue.png",
35+
"title": "",
36+
"hideGenerator": false,
37+
"navLinks": [
38+
{
39+
"label": "Cesium",
40+
"href": "/docs/cesium/index.html"
41+
},
42+
{
43+
"label": "MapboxGL",
44+
"href": "/docs/mapboxgl/index.html"
45+
},
46+
{
47+
"label": "Leaflet",
48+
"href": "/docs/leaflet/index.html"
49+
},
50+
{
51+
"label": "OpenLayers",
52+
"href": "/docs/openlayers/index.html"
53+
}
54+
]
55+
},
56+
"linenums": true
57+
}
58+
}

‎docs/jsdoc-config/cesium/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# cesium的api文档
2+
3+
> 本Cesium的核心M3D功能只能作用于中地数码的Cesium包，不支持开源Cesium包
4+

‎docs/jsdoc-config/cesium/tutorials/1.快速入门.md‎

Whitespace-only changes.

‎docs/jsdoc-config/leaflet/docs.json‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
},
1616
"source": {
1717
"includePattern": ".+\\.js?$",
18-
"include": ["service/", "leaflet/"],
19-
"exclude": ["service/baseserver", "leaflet/extend/leaflet-plugins"]
18+
"include": ["src/service/", "src/leaflet/"],
19+
"exclude": ["src/service/baseserver", "src/leaflet/extend/leaflet-plugins"]
2020
},
2121
"plugins": ["plugins/markdown"],
2222
"templates": {
@@ -29,7 +29,6 @@
2929
"outputSourceFiles": true
3030
},
3131
"better-docs": {
32-
"name": "Client for JavaScript",
3332
"logo": "../image/mapgis_blue.png",
3433
"title": "",
3534
"hideGenerator": false,

‎docs/jsdoc-config/mapboxgl/docs.json‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
},
1515
"source": {
1616
"includePattern": ".+\\.js?$",
17-
"include": ["service/", "mapboxgl/"],
18-
"exclude": ["service/baseserver"]
17+
"include": ["src/service/", "src/mapboxgl/"],
18+
"exclude": ["src/service/baseserver"]
1919
},
2020
"plugins": ["plugins/markdown"],
2121
"templates": {
@@ -28,7 +28,6 @@
2828
"outputSourceFiles": true
2929
},
3030
"better-docs": {
31-
"name": "Client for JavaScript",
3231
"logo": "../image/mapgis_blue.png",
3332
"title": "",
3433
"hideGenerator": false,

‎docs/jsdoc-config/openlayers/docs.json‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
},
1515
"source": {
1616
"includePattern": ".+\\.js?$",
17-
"include": ["service/"],
18-
"exclude": ["service/baseserver"]
17+
"include": ["src/service/"],
18+
"exclude": ["src/service/baseserver"]
1919
},
2020
"plugins": ["plugins/markdown"],
2121
"templates": {
@@ -28,7 +28,6 @@
2828
"outputSourceFiles": true
2929
},
3030
"better-docs": {
31-
"name": "Client for JavaScript",
3231
"logo": "../image/mapgis_blue.png",
3332
"title": "",
3433
"hideGenerator": false,

‎docs/templates/better-docs/publish.js‎

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -381,15 +381,25 @@ function buildGroupNav (members, title) {
381381
if (title) {
382382
nav += '<h2>' + title + '</h2>'
383383
}
384-
nav += buildMemberNav(members.tutorials || [], 'Tutorials', seenTutorials, linktoTutorial)
384+
/* nav += buildMemberNav(members.tutorials || [], 'Tutorials', seenTutorials, linktoTutorial)
385385
nav += buildMemberNav(members.modules || [], 'Modules', {}, linkto)
386386
nav += buildMemberNav(members.externals || [], 'Externals', seen, linktoExternal)
387387
nav += buildMemberNav(members.namespaces || [], 'Namespaces', seen, linkto)
388388
nav += buildMemberNav(members.classes || [], 'Classes', seen, linkto)
389389
nav += buildMemberNav(members.interfaces || [], 'Interfaces', seen, linkto)
390390
nav += buildMemberNav(members.events || [], 'Events', seen, linkto)
391391
nav += buildMemberNav(members.mixins || [], 'Mixins', seen, linkto)
392-
nav += buildMemberNav(members.components || [], 'Components', seen, linkto)
392+
nav += buildMemberNav(members.components || [], 'Components', seen, linkto) */
393+
394+
nav += buildMemberNav(members.tutorials || [], '向导', seenTutorials, linktoTutorial)
395+
nav += buildMemberNav(members.modules || [], '模块', {}, linkto)
396+
nav += buildMemberNav(members.externals || [], 'Externals', seen, linktoExternal)
397+
nav += buildMemberNav(members.namespaces || [], '命名空间', seen, linkto)
398+
nav += buildMemberNav(members.classes || [], '类名', seen, linkto)
399+
nav += buildMemberNav(members.interfaces || [], '接口', seen, linkto)
400+
nav += buildMemberNav(members.events || [], '事件', seen, linkto)
401+
nav += buildMemberNav(members.mixins || [], '混入', seen, linkto)
402+
nav += buildMemberNav(members.components || [], '组件', seen, linkto)
393403

394404
if (members.globals && members.globals.length) {
395405
globalNav = ''
@@ -403,10 +413,10 @@ function buildGroupNav (members, title) {
403413

404414
if (!globalNav) {
405415
// turn the heading into a link so you can actually get to the global page
406-
nav += '<h3>' + linkto('global', 'Global') + '</h3>'
416+
nav += '<h3>' + linkto('global', '全局') + '</h3>'
407417
}
408418
else {
409-
nav += '<h3>Global</h3><ul>' + globalNav + '</ul>'
419+
nav += '<h3>全局</h3><ul>' + globalNav + '</ul>'
410420
}
411421
}
412422
nav += '</div>'
@@ -430,13 +440,15 @@ function buildGroupNav (members, title) {
430440
*/
431441
function buildNav(members, navTypes = null, betterDocs) {
432442
const href = betterDocs.landing ? 'docs.html' : 'index.html'
433-
var nav = navTypes ? '' : `<h2><a href="${href}">Documentation</a></h2>`
443+
var nav = navTypes ? '' : `<h2><a href="${href}">API文档</a></h2>`
434444

435445
var categorised = {}
436446
var rootScope = {}
437447

438448
var types = navTypes || ['modules', 'externals', 'namespaces', 'classes',
439449
'components', 'interfaces', 'events', 'mixins', 'globals']
450+
/* var types = navTypes || ['模块', 'externals', '命名空间', '类',
451+
'组件', '接口', '事件', '混入', '全局'] */
440452
types.forEach(function(type) {
441453
if (!members[type]) { return }
442454
members[type].forEach(function(element) {

‎docs/templates/better-docs/styles/components/top-navbar.sass‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,12 @@
5454
border-bottom: 2px solid $black
5555
@include until($tablet)
5656
&.user-link
57-
display: none
57+
display: none
58+
59+
.mapgis-webclient-logo
60+
@include until($desktop)
61+
z-index: 100
62+
display: none
63+
64+
.mapgis-webclient-logo
65+
display: none

0 commit comments

Comments
 (0)