{"id":13509511,"url":"https://github.com/websemantics/markdown-browser","last_synced_at":"2025-04-09T23:30:48.093Z","repository":{"id":150921677,"uuid":"81381793","full_name":"websemantics/markdown-browser","owner":"websemantics","description":"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","archived":false,"fork":false,"pushed_at":"2017-03-27T02:14:36.000Z","size":1585,"stargazers_count":12,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-24T13:21:23.187Z","etag":null,"topics":["docs","file-browser","markdown","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/websemantics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-02-08T22:17:38.000Z","updated_at":"2022-09-24T18:01:30.000Z","dependencies_parsed_at":"2023-04-09T04:33:25.045Z","dependency_job_id":null,"html_url":"https://github.com/websemantics/markdown-browser","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/websemantics%2Fmarkdown-browser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/websemantics%2Fmarkdown-browser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/websemantics%2Fmarkdown-browser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/websemantics%2Fmarkdown-browser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/websemantics","download_url":"https://codeload.github.com/websemantics/markdown-browser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248129532,"owners_count":21052589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","file-browser","markdown","php"],"created_at":"2024-08-01T02:01:08.801Z","updated_at":"2025-04-09T23:30:47.156Z","avatar_url":"https://github.com/websemantics.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"```\n ─────    ╭──┬──╮ ╭──╮ ┬──╮ ┬ ╭─ ╭┬─╮ ╭──╮ ┬   ┬ ╭─╮ ╭   ╭──╮  ┬──╮ ╭──╮ ┬   ┬ ╭──╮ ╭──╮ ┬──╮    ─────\n   ────   │  │  │ ├──┤ ├─┬╯ ├─┴╮  │ │ │  │ │ │ │ │ │ │   ├──┴╮ ├─┬╯ │  │ │ │ │ ╰──╮ ├─┤  ├─┬╯   ────\n      ──  ┴  ┴  ┴ ┴  ┴ ┴ ╰─ ┴  ┴ ─┴─╯ ╰──╯ ╰─┴─╯ ╯ ╰─╯   ╰───╯ ┴ ╰─ ╰──╯ ╰─┴─╯ ╰──╯ ╰──╯ ┴ ╰─  ──\n```\n\u003e Straightforward file browser for viewing markdown and other file types locally in Github-like fashion.\n\n## Look Mum, No Hands\n\nThis 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. \n\nHaving 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. \n\n## Getting Started\n\nDrop `index.php` in your projects's documentation folder then view it in the browser, that's it!\n\n## Preview\n\n| ![](https://github.com/websemantics/markdown-browser/raw/master/preview.gif)        |\n| ------------- |\n| The docs folder featured is from [Svelte](https://github.com/sveltejs/svelte) project.      |\n\n## Baked-in Goodies\n\nCredits to the following projects for making this possible,\n\n- [Markdown Parser in PHP](https://github.com/erusev/parsedown)\n- [Github Markdown CSS](https://github.com/sindresorhus/github-markdown-css)\n- [Prism Syntax Highlighting](https://github.com/PrismJS/prism)\n\n## Support\n\nNeed help or have a question? post at [StackOverflow](https://stackoverflow.com/questions/tagged/markdown-browser+websemantics).\n\n*Please don't use the issue trackers for support/questions.*\n\n*Star if you find this project useful, to show support or simply for being awesome :)*\n\n## Contribution\n\nContributions to this project are accepted in the form of feedback, bugs reports and even better - pull requests.\n\n## License\n\n[MIT license](http://opensource.org/licenses/mit-license.php) Copyright (c) Web Semantics, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebsemantics%2Fmarkdown-browser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebsemantics%2Fmarkdown-browser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebsemantics%2Fmarkdown-browser/lists"}