This repository was archived by the owner on Apr 8, 2019. It is now read-only.
File tree 4 files changed +7
-7
lines changed
4 files changed +7
-7
lines changed Original file line number Diff line number Diff line change @@ -18,15 +18,16 @@ You can update current version using `npm update -g doc-viewer`
18
18
## Develop
19
19
20
20
- npm install NOTE: you have to run as admin in windows in order to install node-sass
21
- - ` node index.js ` to start server
22
- - ` localhost:3000/README.md ` and you will see the markdown in this projects ` doc ` folder
21
+ - ` gulp dev ` to start server and enable watch, the express server will reload when file change, but you have
22
+ to hit f5 to refresh the client.
23
23
24
24
![ screen] ( public/screen.PNG )
25
25
26
26
## RoadMap
27
27
28
28
- [x] simple render
29
- - [ ] allow combine options, toc, highlight etc.
29
+ - [x] a global command line. ` npm install -g doc-viewer ` , then you can use it like python's simple server
30
30
- [x] make links in markdown work.
31
+ - [x] toc support
32
+ - [ ] allow combine options, toc, highlight etc.
31
33
- [ ] parse all markdown file and generate html and search.
32
- - [x] a global command line. ` npm install -g doc-viewer ` , then you can use it like python's simple server
Original file line number Diff line number Diff line change @@ -20,11 +20,8 @@ function listFile(docRoot) {
20
20
}
21
21
// TODO: decide if it is a file or folder
22
22
var stat = fs . statSync ( folder ) ;
23
- //console.log(stat);
24
- console . log ( 'folder is ' + folder ) ;
25
23
if ( ! stat . isDirectory ( ) ) {
26
24
folder = path . dirname ( folder ) ;
27
- console . log ( 'now folder is ' + folder ) ;
28
25
}
29
26
30
27
var markdown = { content : '' , toc : '' } ;
Original file line number Diff line number Diff line change 8
8
<body >
9
9
<!-- A slide bar to show search and folder or category? -->
10
10
<div class =" sidebar dark-blue-bkg" >
11
+ <!-- TODO: add css for the logo -->
12
+ <img src =" /doc-viewer.PNG" alt =" " >
11
13
<ul >
12
14
<% for (var i = 0 ;i < dir .length ;i++ ) { % >
13
15
< li>
You can’t perform that action at this time.
0 commit comments