quick-doc-viewer 0.1.0

A quick documentation viewer for developers to preview documentations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# Quick doc viewer

Page UI design draft:

    ------------------------------------------------------------------------------------------------------------
    [Files] | [README if present] [SUMMARY if present] [home if present] [index if present]
    ------------------------------------------------------------------------------------------------------------
    Location: [root] / [sub dir] / ... / [current dir] / [current file]
    ------------------------------------------------------------------------------------------------------------
    [raw] [preview] [preview as Markdown] [preview as plain text]
    ------------------------------------------------------------------------------------------------------------
    content
    ------------------------------------------------------------------------------------------------------------

Special files:

    README[.*]
    SUMMARY[.*]
    home[.*]
    index[.*]

URI paths:

    /
    /{path/to/file}
    /{path/to/file}?format=markdown
    /{path/to/file}?raw=true

Supported formats for preview:

* Markdown

If the value of format parameter is not provided, guess the preview format from file extension of the file name.

Content of files:

    [path/to/file]
    [path/to/file]
    [path/to/file]
    ...

Directories ignored:

* .git
* .hg
* .svn