{"id":19763287,"url":"https://github.com/webdiscus/github-readme-preview","last_synced_at":"2026-05-05T08:34:50.487Z","repository":{"id":113225050,"uuid":"499827429","full_name":"webdiscus/github-readme-preview","owner":"webdiscus","description":"Markdown file preview in GitHub makeup on localhost.","archived":false,"fork":false,"pushed_at":"2025-03-19T16:52:42.000Z","size":507,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-18T03:39:59.710Z","etag":null,"topics":["github","markdown","preview","pug","pug-plugin","readme","theme"],"latest_commit_sha":null,"homepage":"","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webdiscus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-06-04T13:01:07.000Z","updated_at":"2025-03-19T16:52:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"759f2ba9-d3d6-4f6b-bb34-24f26290bd98","html_url":"https://github.com/webdiscus/github-readme-preview","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/webdiscus/github-readme-preview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fgithub-readme-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fgithub-readme-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fgithub-readme-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fgithub-readme-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webdiscus","download_url":"https://codeload.github.com/webdiscus/github-readme-preview/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdiscus%2Fgithub-readme-preview/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32642223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"online","status_checked_at":"2026-05-05T02:00:06.033Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["github","markdown","preview","pug","pug-plugin","readme","theme"],"created_at":"2024-11-12T04:08:43.933Z","updated_at":"2026-05-05T08:34:50.467Z","avatar_url":"https://github.com/webdiscus.png","language":"SCSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# github-readme-preview\n\nThis is markdown file preview in GitHub makeup on localhost.\\\nSupports for the dark and light themes of browser.\n\n![preview](https://github.com/webdiscus/github-readme-preview/blob/master/docs/assets/images/preview.png?raw=true \"preview\")\n\n## Required\n\n- Node.js 16\n- Npm\n\n## Install\n\n```\ngit clone https://github.com/webdiscus/github-readme-preview.git\ncd github-readme-preview\nnpm install\n```\n\n## Setup\n\nCreate/copy a markdown file, e.g. `README.md`, in the `github-readme-preview/` directory\nor in any subdirectory.\n\n\n## Start preview in commandline\n\nRun from the `github-readme-preview/` directory:\n\n```\nnpm start --file=path/to/markdown_file\n```\n\nThe commandline argument `--file` is optional. Default file is `README.md`.\nThe file extension `.md` can be omitted.\n\nNow you can open this file in a code editor, change the file and save it.\nThe browser will show the changes.\n\n## Stop preview\n\nPress `CTRL` + `C`\n\n## Usage examples\n\nPreview the `./README.md` file:\n```\nnpm start\n```\n\nPreview the `./CHANGELOG.md` file:\n```\nnpm start --file=CHANGELOG\n```\n\nPreview the `./docs/myMarkdownFile.md` file:\n```\nnpm start --file=docs/myMarkdownFile\n```\n\nPreview a file with absolute path, like `/absolute/path/to/README.md`:\n```\nnpm start --file=/absolute/path/to/README\n```\n\n## Switch dark / light themes\n\nOpen the browser settings and change browser theme to `dark` or `light`.\n\nFor example, in Firefox, open the address `about:preferences`.\\\nOn the settings site go to `General \u003e Language and Appearence \u003e Web site appearence`.\\\nThen select theme: `Light` or `Dark`.\n\n## Syntax highlighting example\n\n_HTML_\n```html\n\u003c!-- Comment --\u003e\n\u003cdiv class=\"container\"\u003e\n  \u003cp\u003eParagraph\u003c/p\u003e\n\u003c/div\u003e\n```\n\n_JavaScript_\n```js\nconst arr = [1, 2, 'banana'];\n```\n\n## ⚠️ Limitation\n\nRelative image path is not supported, use URL, e.g.:\n```\n![image](https://github.com/path/to/docs/image.png?raw=true \"image\")\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdiscus%2Fgithub-readme-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebdiscus%2Fgithub-readme-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdiscus%2Fgithub-readme-preview/lists"}