https://github.com/websemantics/markdown-browser
Github flavoured, local file browser (a single PHP file without dependencies) for viewing your project's markdown documentation files. Also, see https://github.com/websemantics/markdown-browser-plus
https://github.com/websemantics/markdown-browser
docs file-browser markdown php
Last synced: 3 months ago
JSON representation
Github flavoured, local file browser (a single PHP file without dependencies) for viewing your project's markdown documentation files. Also, see https://github.com/websemantics/markdown-browser-plus
- Host: GitHub
- URL: https://github.com/websemantics/markdown-browser
- Owner: websemantics
- License: mit
- Created: 2017-02-08T22:17:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-27T02:14:36.000Z (over 8 years ago)
- Last Synced: 2025-03-24T13:21:23.187Z (3 months ago)
- Topics: docs, file-browser, markdown, php
- Language: PHP
- Homepage:
- Size: 1.51 MB
- Stars: 12
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
```
───── ╭──┬──╮ ╭──╮ ┬──╮ ┬ ╭─ ╭┬─╮ ╭──╮ ┬ ┬ ╭─╮ ╭ ╭──╮ ┬──╮ ╭──╮ ┬ ┬ ╭──╮ ╭──╮ ┬──╮ ─────
──── │ │ │ ├──┤ ├─┬╯ ├─┴╮ │ │ │ │ │ │ │ │ │ │ ├──┴╮ ├─┬╯ │ │ │ │ │ ╰──╮ ├─┤ ├─┬╯ ────
── ┴ ┴ ┴ ┴ ┴ ┴ ╰─ ┴ ┴ ─┴─╯ ╰──╯ ╰─┴─╯ ╯ ╰─╯ ╰───╯ ┴ ╰─ ╰──╯ ╰─┴─╯ ╰──╯ ╰──╯ ┴ ╰─ ──
```
> Straightforward file browser for viewing markdown and other file types locally in Github-like fashion.
## Look Mum, No Hands
This project was put together to solve the problem of having to push changes to Github too often -while writing README, documentation files- just to see how they look live. It also lifts the burden of having to use static site generators to produce redundant html files from markdown while developing locally.
Having a markdown viewer as a single PHP file keeps things simple and pleasant until you decide to push changes to Github for the world to see.
## Getting Started
Drop `index.php` in your projects's documentation folder then view it in the browser, that's it!
## Preview
|  |
| ------------- |
| The docs folder featured is from [Svelte](https://github.com/sveltejs/svelte) project. |
## Baked-in Goodies
Credits to the following projects for making this possible,
- [Markdown Parser in PHP](https://github.com/erusev/parsedown)
- [Github Markdown CSS](https://github.com/sindresorhus/github-markdown-css)
- [Prism Syntax Highlighting](https://github.com/PrismJS/prism)
## Support
Need help or have a question? post at [StackOverflow](https://stackoverflow.com/questions/tagged/markdown-browser+websemantics).
*Please don't use the issue trackers for support/questions.*
*Star if you find this project useful, to show support or simply for being awesome :)*
## Contribution
Contributions to this project are accepted in the form of feedback, bugs reports and even better - pull requests.
## License
[MIT license](http://opensource.org/licenses/mit-license.php) Copyright (c) Web Semantics, Inc.