Skip to content
This repository was archived by the owner on Apr 8, 2019. It is now read-only.

Commit b29d473

Browse files
committed
Update screen shot
- remove two console.log for debug folder - add logo to side bar - update readme.md's todolist
1 parent f0d0706 commit b29d473

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,16 @@ You can update current version using `npm update -g doc-viewer`
1818
## Develop
1919

2020
- 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.
2323

2424
![screen](public/screen.PNG)
2525

2626
## RoadMap
2727

2828
- [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
3030
- [x] make links in markdown work.
31+
- [x] toc support
32+
- [ ] allow combine options, toc, highlight etc.
3133
- [ ] 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

lib/middleware/listFile.js

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,8 @@ function listFile(docRoot) {
2020
}
2121
// TODO: decide if it is a file or folder
2222
var stat = fs.statSync(folder);
23-
//console.log(stat);
24-
console.log('folder is ' + folder);
2523
if (!stat.isDirectory()) {
2624
folder = path.dirname(folder);
27-
console.log('now folder is ' + folder);
2825
}
2926

3027
var markdown = {content: '', toc: ''};

public/screen.PNG

35.5 KB
Loading

views/doc.ejs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
<body>
99
<!--A slide bar to show search and folder or category? -->
1010
<div class="sidebar dark-blue-bkg">
11+
<!-- TODO: add css for the logo -->
12+
<img src="/doc-viewer.PNG" alt="">
1113
<ul>
1214
<% for(var i = 0;i < dir.length;i++) { %>
1315
<li>

0 commit comments

Comments
 (0)