mdserver reads a directory tree and picks out all files that are markdown documents. These are then presented as filenames to user via browser. When clicked, the file is run through the markdown process and shown to user.
If you have a working go installation on a Unix-like OS:
go get github.com/hotei/mdserver
Will copy github.com/hotei/mdserver to the first entry of your $GOPATH
or if go is not installed yet :
cd DestinationDirectory
git clone https://github.com/hotei/mdserver.git
- You can/should change the directory where the search for markdown docs begins.
- Serves files with the following extensions
- .md
- .mdown
- .markdown
- Standalone webserver executable is medium sized (for go)
- go 1.4.2 file is about 6.5 MB
- go 1.5rc1 file is about 8.2 MB
- you can supply a list of dirs if you want to exclude them from processing
- IP and port number served is set by flag - default is 8281 (a random pick)
- can be run at "localhost" if appropriate (more secure, but can't be used from other computers)
- refreshes list every 5 minutes (flag setable)
- If used in forensic environment you may need to adjust file permissions of the markdown files to allow the server to read all files.
Typical usage is :
mdserver &
None Known
- Essential:
- TBD
- Nice:
- use fsnotify to refresh list only when something changes
- 2015-06-20 minor update pushed
- skipDirs implemented
- suppress generic duplicated README.md
- 2015-04-30 revisited for go 1.4.2 update
- 2014-03-25 Working
- 2014-03-25 Started
Comments can be sent to hotei1352@gmail.com or to user "hotei" at github.com. License is BSD-two-clause, in file "LICENSE"
The 'mdserver' go package/program is distributed under the Simplified BSD License:
Copyright (c) 2014-2015 David Rook. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Documentation (c) 2015 David Rook
// EOF README-mdserver.md (this markdown document tested OK with blackfriday)
DO NOT EDIT BELOW - Generated by godoc2md
mdserver.go (c) 2013-2015 David Rook - all rights reserved
TODO(mdr) need a way to watch fs for changes before re-starting loadFiles()
DO NOT EDIT ABOVE - Generated by godoc2md
github.com/hotei/mdserver imports
C
bufio
bytes
compress/flate
compress/gzip
compress/zlib
container/list
crypto
crypto/aes
crypto/cipher
crypto/des
crypto/dsa
crypto/ecdsa
crypto/elliptic
crypto/hmac
crypto/md5
crypto/rand
crypto/rc4
crypto/rsa
crypto/sha1
crypto/sha256
crypto/sha512
crypto/subtle
crypto/tls
crypto/x509
crypto/x509/pkix
encoding/asn1
encoding/base64
encoding/binary
encoding/hex
encoding/pem
errors
flag
fmt
github.com/hotei/bmp
github.com/russross/blackfriday
github.com/shurcooL/sanitized_anchor_name
hash
hash/adler32
hash/crc32
image
image/color
image/internal/imageutil
image/jpeg
image/png
internal/singleflight
internal/syscall/unix
io
io/ioutil
log
math
math/big
math/rand
mime
mime/multipart
mime/quotedprintable
net
net/http
net/http/internal
net/textproto
net/url
os
path
path/filepath
reflect
regexp
regexp/syntax
runtime
sort
strconv
strings
sync
sync/atomic
syscall
time
unicode
unicode/utf8
unsafe
deadcode results:
deadcode: mdserver.go:60:1: myGOs is unused
deadcode: images.go:130:1: bmpHandler is unused