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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

pub static MARKDOWN_FILE_EXTENSIONS: &[&str] = &[
    "md",
    "markdown",
    "mkd",
];

pub static SPECIAL_FILE_NAMES_LOWERCASE: &[&str] = &[
    "readme",
    "summary",
    "home",
    "index",
];

pub static COMMON_TEXT_FILE_EXTENSIONS : &[&str] = &[
    // AsciiDoc
    "adoc",
    "asciidoc",
    // C and C++
    "c",
    "cpp",
    "cxx",
    "h",
    "hpp",
    // CSS
    "css",
    // HTML
    "htm",
    "html",
    // JavaScript
    "js",
    "json",
    // Markdown
    "md",
    "markdown",
    "mkd",
    // plain text
    "text",
    "txt",
    // shell script
    "sh",
    "bash",
    "csh",
    "ksh",
    "fish",
    "zsh",
    "bat",
    "cmd",
    "ps1",
    // configuration
    "cfg",
    "cnf",
    "conf",
    "config",
    // Others
    "coffee",
    "cs",
    "csv",
    "cr",
    "ex",
    "erl",
    "f",
    "gemini",
    "gmi",
    "go",
    "hbs",
    "inf",
    "ini",
    "jad",
    "java",
    "jsx",
    "kt",
    "less",
    "lisp",
    "log",
    "lst",
    "lua",
    "mk",
    "opml",
    "pas",
    "rb",
    "rc",
    "reg",
    "php",
    "pony",
    "py",
    "rs",
    "rst",
    "sass",
    "scss",
    "scheme",
    "ss",
    "scm",
    "sgm",
    "sgml",
    "shtml",
    "sln",
    "toml",
    "tsv",
    "xml",
    "uu",
    "vb",
    "vbs",
    "vcard",
    "vml",
    "yaml",
    "yml",
    "zig",
];

pub static COMMON_IMAGE_FILE_EXTENSIONS : &[&str] = &[
    "bmp",
    "gif",
    "ico",
    "jpg",
    "jpeg",
    "png",
    "svg",
    "webp",
];

pub static COMMON_AUDIO_FILE_EXTENSIONS : &[&str] = &[
    "mid",
    "midi",
    "mp3",
    "mpga",
    "oga",
    "wav",
    "wave",
    "weba",
];

pub static COMMON_VIDEO_FILE_EXTENSIONS : &[&str] = &[
    "avi",
    "mp4",
    "mpeg",
    "mpg",
    "ogg",
    "ogv",
    "webm",
];

pub static IGNORED_DIRECTORIES : &[&str] = &[
    ".git",
    ".hg",
    ".svn",
];