├── LICENSE
├── README.md
├── assets
├── eolinker_sim.png
├── favicon.ico
└── jiantou.png
├── examples
├── assets
│ ├── eolinker_sim.png
│ ├── favicon.ico
│ └── jiantou.png
├── fonts
│ ├── FontAwesome.otf
│ ├── editormd-logo.eot
│ ├── editormd-logo.svg
│ ├── editormd-logo.ttf
│ ├── editormd-logo.woff
│ ├── fontawesome-webfont.eot
│ ├── fontawesome-webfont.svg
│ ├── fontawesome-webfont.ttf
│ ├── fontawesome-webfont.woff
│ └── fontawesome-webfont.woff2
├── index.css
├── index.html
├── libs
│ ├── editormd.min.css
│ ├── editormd.min.js
│ ├── flowchart.min.js
│ ├── jquery-2.2.1.js
│ ├── jquery.flowchart.min.js
│ ├── marked.min.js
│ ├── prettify.min.js
│ ├── raphael.min.js
│ ├── sequence-diagram.min.js
│ └── underscore.min.js
├── md
│ ├── index.md
│ └── 账户管理
│ │ ├── 交易管理
│ │ ├── 发票管理.md
│ │ └── 查询交易记录.md
│ │ └── 基本操作
│ │ ├── 修改密码.md
│ │ ├── 完善个人资料.md
│ │ ├── 忘记密码.md
│ │ ├── 注册.md
│ │ └── 登录.md
├── router.js
└── sidebar.js
├── fonts
├── FontAwesome.otf
├── editormd-logo.eot
├── editormd-logo.svg
├── editormd-logo.ttf
├── editormd-logo.woff
├── fontawesome-webfont.eot
├── fontawesome-webfont.svg
├── fontawesome-webfont.ttf
├── fontawesome-webfont.woff
└── fontawesome-webfont.woff2
├── index.html
├── libs
├── editormd.min.css
├── editormd.min.js
├── flowchart.min.js
├── jquery-2.2.1.js
├── jquery.flowchart.min.js
├── marked.min.js
├── prettify.min.js
├── raphael.min.js
├── sequence-diagram.min.js
└── underscore.min.js
├── md
├── father
│ └── child
│ │ ├── demo1.md
│ │ └── demo2.md
└── index.md
├── router.js
└── sidebar.js
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## 欢迎使用markdown-viewer
2 | markdown-viewer是由eoLinker团队开发的超轻量级的Markdown文档展示系统,仅需几行代码配置,即可将Markdown文档包装成带目录层级的网站,方便人员查看。可用于快速构建企业帮助文档、博客、教程、图片站等等。目前已用于支持eoLinker旗下所有帮助文档。
3 |
4 | **主要特性**
5 |
6 | 1. 根据文件系统结构来创建目录层级,方便管理
7 |
8 | 2. 无需任何后端环境,配置简单拿来即用
9 |
10 | 3. 样式美观,可以完美显示图片/层级/表格等内容
11 |
12 | 注意,该markdown-viewer仅用于简化md文件的显示以及生产目录结构,并不包含markdown编辑器,用户需要自行使用其他编辑器编写好markdown文件之后,放置到相应的文件目录下,并且修改好路由配置文件。
13 |
14 | ---
15 |
16 | #### 目录层级说明
17 | |-assets 静态图片文件
18 |
19 | |-examples 示例项目
20 |
21 | |-fonts 字体文件
22 |
23 | |-libs Js库文件
24 |
25 | |-md Markdown文档目录
26 |
27 | |-index.css 首页样式
28 |
29 | |-index.html 首页
30 |
31 | |-README.md README文件
32 |
33 | |-router.js 路由文件,储存目录层级的设置
34 |
35 | |-sidebar.js 侧边栏Js代码
36 |
37 | 实际使用过程中,仅需将Markdown文件分类放置在md文件夹下,并且修改router.js路由文件即可,无需额外配置,不依赖任何后端环境。
38 |
--------------------------------------------------------------------------------
/assets/eolinker_sim.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/assets/eolinker_sim.png
--------------------------------------------------------------------------------
/assets/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/assets/favicon.ico
--------------------------------------------------------------------------------
/assets/jiantou.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/assets/jiantou.png
--------------------------------------------------------------------------------
/examples/assets/eolinker_sim.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/assets/eolinker_sim.png
--------------------------------------------------------------------------------
/examples/assets/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/assets/favicon.ico
--------------------------------------------------------------------------------
/examples/assets/jiantou.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/assets/jiantou.png
--------------------------------------------------------------------------------
/examples/fonts/FontAwesome.otf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/fonts/FontAwesome.otf
--------------------------------------------------------------------------------
/examples/fonts/editormd-logo.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/fonts/editormd-logo.eot
--------------------------------------------------------------------------------
/examples/fonts/editormd-logo.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
--------------------------------------------------------------------------------
/examples/fonts/editormd-logo.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/fonts/editormd-logo.ttf
--------------------------------------------------------------------------------
/examples/fonts/editormd-logo.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/fonts/editormd-logo.woff
--------------------------------------------------------------------------------
/examples/fonts/fontawesome-webfont.eot:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/fonts/fontawesome-webfont.eot
--------------------------------------------------------------------------------
/examples/fonts/fontawesome-webfont.ttf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/fonts/fontawesome-webfont.ttf
--------------------------------------------------------------------------------
/examples/fonts/fontawesome-webfont.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/fonts/fontawesome-webfont.woff
--------------------------------------------------------------------------------
/examples/fonts/fontawesome-webfont.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/eolinker/markdown-viewer/7927752fb6b228a80cc4271a4aa4e75b1706738c/examples/fonts/fontawesome-webfont.woff2
--------------------------------------------------------------------------------
/examples/index.css:
--------------------------------------------------------------------------------
1 | sidebar *,
2 | nav * {
3 | font-family: "Helvetica Neue", "Helvetica", "PingFang SC", "Hiragino Sans GB", "Microsoft YaHei", "Noto Sans CJK SC", "WenQuanYi Micro Hei", "Arial", sans-serif;
4 | margin: 0;
5 | padding: 0;
6 | outline: none;
7 | color: #333;
8 | word-break: break-all;
9 | text-decoration: none;
10 | }
11 |
12 | .pull-left {
13 | float: left;
14 | }
15 |
16 | nav {
17 | position: fixed;
18 | top: 0;
19 | left: 0;
20 | height: 50px;
21 | display: block;
22 | width: 100%;
23 | background-color: #fff;
24 | border-bottom: 1px solid #e5e5e5;
25 | z-index: 1;
26 | line-height: 50px;
27 | }
28 |
29 | nav img {
30 | vertical-align: middle;
31 | margin: 0 5px 0 10px;
32 | }
33 |
34 | sidebar {
35 | position: fixed;
36 | top: 51px;
37 | left: 0;
38 | width: 250px;
39 | background-color: #fff;
40 | border-right: 1px solid #e5e5e5;
41 | font-size: 14px;
42 | height: -webkit-calc(100% - 50px);
43 | height: -ms-calc(100% - 50px);
44 | height: -moz-calc(100% - 50px);
45 | height: calc(100% - 50px);
46 | overflow: auto;
47 | }
48 |
49 | sidebar li {
50 | list-style-type: none;
51 | line-height: 40px;
52 | }
53 |
54 | sidebar li p {
55 | cursor: pointer;
56 | text-indent: 10px;
57 | }
58 |
59 | sidebar li p a {
60 | display: block;
61 | font-size: 14px;
62 | }
63 |
64 |
65 | sidebar li .ico_up .ico {
66 | background-position: 0 -4px;
67 | }
68 |
69 | .hidden ul {
70 | display: none;
71 | }
72 |
73 | .ico {
74 | background-image: url(./assets/jiantou.png);
75 | width: 8px;
76 | height: 4px;
77 | margin-top: 18px;
78 | margin-left: 10px;
79 | }
80 |
81 | .unchild-span {
82 | width: 8px;
83 | height: 4px;
84 | margin-top: 18px;
85 | margin-left: 10px;
86 | }
87 |
88 | .common-level-1 p a {
89 | padding-left: 1em;
90 | }
91 |
92 | .common-level-2 p a {
93 | padding-left: 2em;
94 | }
95 |
96 | .level0 {
97 | background-color: #f3f3f3;
98 | }
99 |
100 | .level1 {
101 | background-color: #eaeaea;
102 | }
103 |
104 | .level0 .common-level-1 {
105 | background-color: #e9e9e9;
106 | }
107 |
108 | .level1 .common-level-2 {
109 | background-color: #ddd;
110 | }
111 |
112 | .elem-active a {
113 | background-color: #2196F3;
114 | color: #fff;
115 | }
116 |
117 | sidebar li .ico_down .ico {
118 | background-position: 0 0;
119 | }
120 |
121 | article {
122 | position: absolute;
123 | top: 60px;
124 | left: 290px;
125 | }
126 |
127 | article .markdown-body img {
128 | border: 1px solid #ededed;
129 | }
130 |
131 |
132 | ::-webkit-scrollbar {
133 | width: 8px;
134 | height: 8px;
135 | }
136 |
137 |
138 |
139 | /* Track */
140 |
141 | ::-webkit-scrollbar-track {
142 | //-webkit-box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.3);
143 | //-webkit-border-radius: 10px;
144 | //border-radius: 10px;
145 | background: #fff;
146 | }
147 |
148 |
149 |
150 | /* Handle */
151 |
152 | ::-webkit-scrollbar-thumb {
153 | -webkit-border-radius: 10px;
154 | border-radius: 10px;
155 | background: #ccc; //-webkit-box-shadow: inset 0 0 6px rgba(0, 0, 0, 0.5);
156 | }
157 |
158 | ::-webkit-scrollbar-thumb:window-inactive {
159 | background: #ddd;
160 | }
--------------------------------------------------------------------------------
/examples/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |