This is a read only method of viewing a repository full of md documents, powered by parsedown. You will still need to edit the files in a text or markdown editor, but simply install this on a php server and point it to your directory and it will glob all the files and convert all markdown to html. All conversion is handled live, so you merely need to save and refresh your browser to view updates.
- Live conversion of md to html
- built in search
- LIVE search
- with alphabetization!
- works with an existing md repository
- can display file modification date
- permalink functionality without using a database or changing file modification dates
- can popout article into new window for easier multitasking when referencing to the article while working in another tab
- check out a live demo!
- want to easily document procedures for yourself/others
- have lots of markdown files for whatever reason you want to be able to read easily and search
- and more!
- clone repo into a webserver with php that also has access to the markdown files (this can be a mounted fileshare)
git clone https://github.com/mredig/markdownrepogit submodule initgit submodule update
- copy
config-sample.phptoconfig.phpand customize the settings within - (optional) if using a custom css file, perhaps edit it to support the following selectors (you can base it from the included css files)
#markdownRepoLiveSearch.mdrTimestamp.mdrPermalink
- navigate to the webserver address where you cloned into
http://serveraddress/markdownrepo
- server running
php- and
php-mbstring
- and
- browser
- markdown files
- file extension must be lowercase