{"id":17462200,"url":"https://github.com/yunyoujun/star-markdown-css","last_synced_at":"2025-04-19T18:25:47.425Z","repository":{"id":41551067,"uuid":"139312249","full_name":"YunYouJun/star-markdown-css","owner":"YunYouJun","description":"🌟 Markdown Css about violet wandering planet.","archived":false,"fork":false,"pushed_at":"2024-12-29T16:52:22.000Z","size":1117,"stargazers_count":14,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-08T05:01:36.282Z","etag":null,"topics":["markdown-css","yun"],"latest_commit_sha":null,"homepage":"https://yunyoujun.github.io/star-markdown-css/","language":"SCSS","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/YunYouJun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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},"funding":{"github":["YunYouJun"]}},"created_at":"2018-07-01T08:26:15.000Z","updated_at":"2025-03-06T12:05:28.000Z","dependencies_parsed_at":"2025-01-09T07:23:40.639Z","dependency_job_id":null,"html_url":"https://github.com/YunYouJun/star-markdown-css","commit_stats":{"total_commits":113,"total_committers":1,"mean_commits":113.0,"dds":0.0,"last_synced_commit":"f1681f2ff81e318dd5a18c277442dfd3ba0dfe57"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YunYouJun%2Fstar-markdown-css","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YunYouJun%2Fstar-markdown-css/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YunYouJun%2Fstar-markdown-css/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YunYouJun%2Fstar-markdown-css/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YunYouJun","download_url":"https://codeload.github.com/YunYouJun/star-markdown-css/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249235131,"owners_count":21235157,"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":["markdown-css","yun"],"created_at":"2024-10-18T08:05:32.295Z","updated_at":"2025-04-16T11:32:31.767Z","avatar_url":"https://github.com/YunYouJun.png","language":"SCSS","readme":"# star-markdown-css\n\n\u003e Markdown Css about starry.\n\n![Demo](https://github.com/YunYouJun/star-markdown-css/workflows/Demo/badge.svg)\n[![npm](https://img.shields.io/npm/v/star-markdown-css.svg)](https://www.npmjs.com/package/star-markdown-css/)\n[![npm](https://img.shields.io/npm/dt/star-markdown-css.svg)](https://npm-stat.com/charts.html?package=star-markdown-css)\n![npm bundle size (minified + gzip)](https://img.shields.io/bundlephobia/minzip/star-markdown-css.svg)\n![npm bundle size (minified)](https://img.shields.io/bundlephobia/min/star-markdown-css.svg)\n[![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hm/star-markdown-css)](https://cdn.jsdelivr.net/npm/star-markdown-css/dist/yun/markdown.min.css)\n\n- [Demo](https://yunyoujun.github.io/star-markdown-css/)\n\n## Theme\n\n![Planet](./demo/public/img/planet.png)\n![Blood](./demo/public/img/blood.png)\n\n- [x] Planet(default): violet wandering planet\n- [ ] Blood\n- [ ] Pure\n\n## Install By\n\n### Download\n\n- Download [manually](https://github.com/YunYouJun/star-markdown-css/archive/main.zip)\n\n### CDN\n\n- JSDELIVR: \u003chttps://cdn.jsdelivr.net/npm/star-markdown-css/dist/planet/markdown.min.css\u003e\n- unpkg: \u003chttps://unpkg.com/star-markdown-css/dist/planet/markdown.min.css\u003e\n\n### Yarn Or NPM\n\n```sh\nyarn add star-markdown-css\n# or\nnpm install star-markdown-css\n```\n\n## Usage\n\n\u003e Import the `star-markdown.css` file and add a `markdown-body` class to the container of your rendered Markdown and set a width for it.\n\u003e GitHub uses `980px` width and `45px` padding, and `15px` padding for mobile.\n\n### Html\n\nJust use css with link tag.\n\n```html\n\u003clink rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/npm/star-markdown-css/dist/planet/markdown.min.css\" /\u003e\n```\n\n#### Example In HTML\n\nIn html.\n\n```html\n\u003chtml\u003e\n  \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1\" /\u003e\n  \u003clink rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/npm/star-markdown-css/dist/planet/markdown.min.css\" /\u003e\n  \u003cstyle\u003e\n    .markdown-body {\n      box-sizing: border-box;\n      min-width: 200px;\n      max-width: 980px;\n      margin: 0 auto;\n      padding: 45px;\n    }\n\n    @media (max-width: 767px) {\n      .markdown-body {\n        padding: 15px;\n      }\n    }\n  \u003c/style\u003e\n  \u003cbody\u003e\n    \u003carticle class=\"markdown-body\"\u003e\n      \u003ch1\u003eUnicorns\u003c/h1\u003e\n      \u003cp\u003eAll the things\u003c/p\u003e\n    \u003c/article\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n### Vue\n\nJust import it where you need it.\n\n```js\nimport 'star-markdown-css'\n```\n\n#### Example In Vue\n\nIn a vue component.\n\n\u003e You can try [vite-plugin-vue-markdown](https://github.com/mdit-vue/vite-plugin-vue-markdown).\n\n```html\n\u003ctemplate\u003e\n  \u003cdiv class=\"markdown-body\"\u003e\n    \u003c!-- You Markdown --\u003e\n  \u003c/div\u003e\n\u003c/template\u003e\n\n\u003cscript\u003e\n  import 'star-markdown-css'\n  // ...\n\u003c/script\u003e\n\n\u003cstyle\u003e\n  .markdown-body {\n    box-sizing: border-box;\n    min-width: 200px;\n    max-width: 980px;\n    margin: 0 auto;\n    padding: 0px 20px;\n  }\n  @media (max-width: 767px) {\n    .markdown-body {\n      padding: 15px;\n    }\n  }\n\u003c/style\u003e\n```\n\nOr in `main.ts`:\n\n```ts\nimport 'star-markdown-css'\n// ...\n```\n\n## Dev\n\n### Start\n\n```sh\n# Install Dependencies\npnpm\n# start dev\npnpm dev\n# You can see in http://localhost:3333\n```\n\n### Build\n\n```sh\nyarn build\n```\n\n## Intend\n\n- [ ] Add KLK Style (Pure \u0026 Blood)\n- [ ] Use Vue Demo\n\n## Thanks\n\n- [github-markdown-css](https://github.com/sindresorhus/github-markdown-css)\n\n## [Sponsors](https://sponsors.yunyoujun.cn)\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://sponsors.yunyoujun.cn\"\u003e\n    \u003cimg src='https://fastly.jsdelivr.net/gh/YunYouJun/sponsors/public/sponsors.svg'/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","funding_links":["https://github.com/sponsors/YunYouJun"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyunyoujun%2Fstar-markdown-css","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyunyoujun%2Fstar-markdown-css","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyunyoujun%2Fstar-markdown-css/lists"}