Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/websemantics/markdown-browser-plus
Github flavoured, local file browser for viewing your project's markdown documentation files.
https://github.com/websemantics/markdown-browser-plus
docs file-browser file-icons markdown php
Last synced: about 2 months ago
JSON representation
Github flavoured, local file browser for viewing your project's markdown documentation files.
- Host: GitHub
- URL: https://github.com/websemantics/markdown-browser-plus
- Owner: websemantics
- License: other
- Created: 2017-03-26T17:02:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-03-27T02:13:21.000Z (over 7 years ago)
- Last Synced: 2024-11-01T07:33:25.370Z (about 2 months ago)
- Topics: docs, file-browser, file-icons, markdown, php
- Language: CSS
- Size: 4.34 MB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
```
╭────┬───┬──╮╭──────╮╭───┬──╮╭───╮ ╭──╮ ╭────╮╭──────╮╭───╮╭──╮╭──╮╭────┬─╮
│ │├──── ││ ││ │╭╯ ╭╯╭─╯ ││ ╭╮ ││ ││ ││ ││ │
│ ╭╮ ╭╮ ││ ╭╮ ││ ╭─╯│ ╰╯ ╭╯ │ ╭╮ ││ ││ ││ ╰╯ ╰╯ ││ ╭╮ │
│ ││ ││ ││ ╰╯ ││ │ │ ╭╮ ╰╮ │ ╰╯ ││ ╰╯ ││ ││ ││ │
╰───╯╰──╯╰──╯╰───┴──╯╰────╯ ╰───╯╰──╯ ╰─┴────╯╰──────╯╰────┴───┴──╯╰───╯╰─╯
───── ╭╮ ┬─╮ ╭─╮ ┬ ┬ ╭─╮ ╭─╮ ┬─╮ ╭─╮ ┬ ┬ ┬ ╭─╮ ─────
──── ├┴╮ ├┬╯ │ │ │││ ╰─╮ ├┤ ├┬╯ ├─╯ │ │ │ ╰─╮ ────
── ╰─╯ ┴╰─ ╰─╯ ╰┴╯ ╰─╯ ╰─╯ ┴╰─ ┴ ┴─╯ ╰─╯ ╰─╯ ──
```
> Github flavored, local file browser for viewing your project's markdown documentation files.
## Preview
## Getting Started
This project was an improvement on [Markdown Browser](https://github.com/websemantics/markdown-browser) with better code layout and colored file icons. Follow the below instruction to get started,
Clone this repository,
```bash
git clone https://github.com/websemantics/markdown-browser-plus
```
Install [Bower](https://bower.io/) dependencies,
```bash
cd markdown-browser-plus
bower install
```
Install [Composer](https://getcomposer.org/) dependencies,
```bash
composer install
```
View `index.php` file.
## Resources
- [File specific icons for PHP](https://github.com/websemantics/file-icons)
- [A single PHP file file browser](https://github.com/websemantics/markdown-browser)
- [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-plus+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.