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

Commit e13d429

Browse files
committed
Bump to version 0.0.8
- add tasklist #17 - add table class to all table - update screen
1 parent ebd8657 commit e13d429

File tree

6 files changed

+35
-27
lines changed

6 files changed

+35
-27
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
![logo](public/doc-viewer.PNG)
66

7-
View and edit your local markdown documentations in browser.
7+
View markdown documentations locally in browser
88

99
## Usage
1010

@@ -15,19 +15,29 @@ View and edit your local markdown documentations in browser.
1515

1616
You can update current version using `npm update -g doc-viewer`
1717

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+
1829
## Develop
1930

2031
- npm install NOTE: you have to run as admin in windows in order to install node-sass
2132
- `gulp dev` to start server and enable watch, the express server will reload when file change, but you have
2233
to hit f5 to refresh the client.
2334

24-
![screen](public/screen.PNG)
25-
2635
## RoadMap
2736

2837
- [x] simple render
2938
- [x] a global command line. `npm install -g doc-viewer`, then you can use it like python's simple server
3039
- [x] make links in markdown work.
3140
- [x] toc support
41+
- [x] support task list #17
3242
- [ ] allow combine options, toc, highlight etc.
3343
- [ ] parse all markdown file and generate html and search.

doc/README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,34 @@
44

55
type `doc-viewer` in your doc folder and then open your browser `localhost:3000`
66

7-
### view doc in a specific folder
7+
## Features
88

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
1113

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
1327

1428
````javascript
1529
var x = 1
1630
var y = 3
1731
````
1832

19-
````json
20-
{a:123}
21-
````
22-
23-
#### I am nested, yeah
33+
table
2434

2535
| name | type | comment |
2636
| ---- | ---- | ------- |
2737
| 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 ...

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "doc-viewer",
3-
"version": "0.0.7",
3+
"version": "0.0.8",
44
"private":false,
55
"author": "at15",
66
"license": "MIT",

public/assets/style/bundle.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ ul {
3131

3232
.markdown-content {
3333
margin-left: 16%;
34-
padding: 20px;
34+
padding: 0 20px 20px 20px;
3535
width: 70%;
3636
height: 100%;
3737
overflow: auto; }

public/screen.PNG

-2.66 KB
Loading

views/assets/style/layout.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ ul{
4242
.markdown-content {
4343
// TODO:refactor using variables
4444
margin-left: 16%;
45-
padding: 20px;
45+
padding: 0 20px 20px 20px;
4646

4747
width: 70%;
4848
height: 100%;

0 commit comments

Comments
 (0)