This repository was archived by the owner on Apr 8, 2019. It is now read-only.
File tree 6 files changed +35
-27
lines changed
6 files changed +35
-27
lines changed Original file line number Diff line number Diff line change 4
4
5
5
![ logo] ( public/doc-viewer.PNG )
6
6
7
- View and edit your local markdown documentations in browser.
7
+ View markdown documentations locally in browser
8
8
9
9
## Usage
10
10
@@ -15,19 +15,29 @@ View and edit your local markdown documentations in browser.
15
15
16
16
You can update current version using ` npm update -g doc-viewer `
17
17
18
+ ## Features
19
+
20
+ - TOC (table of content) support
21
+ - Show folder and files in sidebar
22
+ - gfm (support task list ) -> use marked
23
+ - code highlight -> use highlightjs
24
+
25
+ Screen shot
26
+
27
+ ![ screen] ( public/screen.PNG )
28
+
18
29
## Develop
19
30
20
31
- npm install NOTE: you have to run as admin in windows in order to install node-sass
21
32
- ` gulp dev ` to start server and enable watch, the express server will reload when file change, but you have
22
33
to hit f5 to refresh the client.
23
34
24
- ![ screen] ( public/screen.PNG )
25
-
26
35
## RoadMap
27
36
28
37
- [x] simple render
29
38
- [x] a global command line. ` npm install -g doc-viewer ` , then you can use it like python's simple server
30
39
- [x] make links in markdown work.
31
40
- [x] toc support
41
+ - [x] support task list #17
32
42
- [ ] allow combine options, toc, highlight etc.
33
43
- [ ] parse all markdown file and generate html and search.
Original file line number Diff line number Diff line change 4
4
5
5
type ` doc-viewer ` in your doc folder and then open your browser ` localhost:3000 `
6
6
7
- ### view doc in a specific folder
7
+ ## Features
8
8
9
- [ lib] ( lib/README.md )
10
- ![ screen] ( screen2.PNG )
9
+ - TOC (table of content) support
10
+ - Show folder and files in side bar
11
+ - gfm (support task list )
12
+ - code highlight
11
13
12
- make sure node has read access to that folder
14
+ ## example
15
+
16
+ task list
17
+
18
+ - [x] b
19
+ - I am just a simple list
20
+ - [ ] not checked
21
+
22
+ links [ lib] ( lib/README.md )
23
+
24
+ images ![ logo] ( doc-viewer.PNG )
25
+
26
+ code
13
27
14
28
```` javascript
15
29
var x = 1
16
30
var y = 3
17
31
````
18
32
19
- ```` json
20
- {a:123 }
21
- ````
22
-
23
- #### I am nested, yeah
33
+ table
24
34
25
35
| name | type | comment |
26
36
| ---- | ---- | ------- |
27
37
| id | int | test |
28
-
29
- #### I am check list
30
-
31
- - [ ] a
32
- - [x] b
33
- - I am just a simple list
34
- - [x] checked
35
- - [ ] not checked
36
-
37
- ## Contribute
38
-
39
- make a pr, and then ...
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " doc-viewer" ,
3
- "version" : " 0.0.7 " ,
3
+ "version" : " 0.0.8 " ,
4
4
"private" :false ,
5
5
"author" : " at15" ,
6
6
"license" : " MIT" ,
Original file line number Diff line number Diff line change 31
31
32
32
.markdown-content {
33
33
margin-left : 16% ;
34
- padding : 20px ;
34
+ padding : 0 20 px 20 px 20px ;
35
35
width : 70% ;
36
36
height : 100% ;
37
37
overflow : auto; }
Original file line number Diff line number Diff line change 42
42
.markdown-content {
43
43
// TODO:refactor using variables
44
44
margin-left : 16% ;
45
- padding : 20px ;
45
+ padding : 0 20 px 20 px 20px ;
46
46
47
47
width : 70% ;
48
48
height : 100% ;
You can’t perform that action at this time.
0 commit comments