{"id":15048653,"url":"https://github.com/eymeen/cool-markdown","last_synced_at":"2026-02-16T15:01:34.818Z","repository":{"id":234953258,"uuid":"789798460","full_name":"eymeen/cool-markdown","owner":"eymeen","description":"Vanilla Markdown Tricks For Much Better README Files","archived":false,"fork":false,"pushed_at":"2024-04-21T16:51:28.000Z","size":9,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-04T21:18:21.224Z","etag":null,"topics":["best-readme","cool-readme","github-readme-profile","markdown","markdown-editor","markdown-parser","markdown-previewer","markdown-to-html","markdown-viewer","readme","readme-badges","readme-bolierplate","readme-card","readme-generator","readme-profile","readme-stats"],"latest_commit_sha":null,"homepage":"","language":null,"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/eymeen.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2024-04-21T15:30:43.000Z","updated_at":"2025-02-27T20:49:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"bbda0181-473f-46a3-a708-1b1d5563bea4","html_url":"https://github.com/eymeen/cool-markdown","commit_stats":null,"previous_names":["eymeen/cool-markdown"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/eymeen/cool-markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eymeen%2Fcool-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eymeen%2Fcool-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eymeen%2Fcool-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eymeen%2Fcool-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eymeen","download_url":"https://codeload.github.com/eymeen/cool-markdown/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eymeen%2Fcool-markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29510518,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T09:05:14.864Z","status":"ssl_error","status_checked_at":"2026-02-16T08:55:59.364Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["best-readme","cool-readme","github-readme-profile","markdown","markdown-editor","markdown-parser","markdown-previewer","markdown-to-html","markdown-viewer","readme","readme-badges","readme-bolierplate","readme-card","readme-generator","readme-profile","readme-stats"],"created_at":"2024-09-24T21:14:47.115Z","updated_at":"2026-02-16T15:01:34.801Z","avatar_url":"https://github.com/eymeen.png","language":null,"readme":"# cool-markdown\nVanilla Markdown Tricks For Much Better README Files, everything you need \n\n### todo\n- [x] vanilla MD\n- [ ] with jekyll\n- [ ] cool non-vanilla MD but using fancy recourses, not the typical crap.\n- [ ] profile/project README examples\n- [ ] simple online editor as github page\n- [ ] Future: tiny details README (such as social link decoration, ability to change font)\n- [ ] add valuable resources list that has readme thingies to add (like shields and other real-time data viewing UIs)\n- [ ] Make a file that has README rules to make the file attractive and informative\n\n# Tricks\n\n## permanent link to a code snippet\n[**How To Get a Link**](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-a-permanent-link-to-a-code-snippet)  \n```\nhttps://github.com/USERNAME/REPOSITORY/blob/COMMIT_HASH/FILENAME?plain=1#LX-LX\n```\n\u003e LX - LX  == line range, written like this (exmp) : L3-L11\n\nhttps://github.com/eymeen/cool-markdown/blob/1279864b0306ea9cf597553d47389276727bf987/README.md?plain=1#L11-L22\n\n## Alerts\n\u003e [!NOTE]\n\u003e Useful information that users should know, even when skimming content.\n\n\u003e [!TIP]\n\u003e Helpful advice for doing things better or more easily.\n\n\u003e [!IMPORTANT]\n\u003e Key information users need to know to achieve their goal.\n\n\u003e [!WARNING]\n\u003e Urgent info that needs immediate user attention to avoid problems.\n\n\u003e [!CAUTION]\n\u003e Advises about risks or negative outcomes of certain actions.\n## Todo Special\n- [x] #1\n- [ ] https://github.com/eymeen/cool-markdown/issues/1\n- [ ] https://github.com/eymeen/cool-markdown/pulls/1\n- [ ] Add delight to the experience when all tasks are complete\n\n## Yaml, [jekyll](https://github.com/jekyll/jekyll-gist)\nAlthough this is not considered 100% vanilla, but it's something you can do in github, and it will enable you to make better stuff in the MD. \n## embed gists\n```\n{% gist __NUMBER__ __FILENAME__ %}\n```\n`{% gist 5555251 gist.md %}`\n\n## embed repos\n[![Repository Name](https://github-readme-stats.vercel.app/api/pin/?username=eymeen\u0026repo=cool-markdown)](https://github.com/eymeen/cool-markdown)\n\n\n## Diagrams\nyou can create [here](https://mermaid.live/edit) and paste it in the MD file\n\n### Simple\n```mermaid\ngraph TD;\n    Create_this--\u003eGet_Sponsored;\n    Create_this--\u003eGet_10_stars;\n    Create_this--\u003eget_100_forks;\n    get_100_forks--\u003eD;\n    Get_10_stars--\u003eD;\n    Get_Sponsored--\u003eD;\n```\n### \n```mermaid\nxychart-beta\ntitle \"Sales Revenue\"\nx-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]\ny-axis \"Revenue (in $)\" 4000 --\u003e 11000\nbar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]\nline [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]\n```\n### geojson Maps\n```geojson\n{\n  \"type\": \"FeatureCollection\",\n  \"features\": [\n    {\n      \"type\": \"Feature\",\n      \"id\": 1,\n      \"properties\": {\n        \"ID\": 0\n      },\n      \"geometry\": {\n        \"type\": \"Polygon\",\n        \"coordinates\": [\n            [\n                [37.85, 36.2],\n                [37.85, 36.15],\n                [37.9, 36.15],\n                [37.95, 36.18],\n                [37.9, 36.2],\n                [37.85, 36.2]\n            ]\n        ]\n      }\n    }\n  ]\n}\n```\n### topojson Maps \n```topojson\n{\n  \"type\": \"Topology\",\n  \"transform\": {\n    \"scale\": [0.0005000500050005, 0.00010001000100010001],\n    \"translate\": [100, 0]\n  },\n  \"objects\": {\n    \"example\": {\n      \"type\": \"GeometryCollection\",\n      \"geometries\": [\n        {\n          \"type\": \"Point\",\n          \"properties\": {\"prop0\": \"value0\"},\n          \"coordinates\": [4000, 5000]\n        },\n        {\n          \"type\": \"LineString\",\n          \"properties\": {\"prop0\": \"value0\", \"prop1\": 0},\n          \"arcs\": [0]\n        },\n        {\n          \"type\": \"Polygon\",\n          \"properties\": {\"prop0\": \"value0\",\n            \"prop1\": {\"this\": \"that\"}\n          },\n          \"arcs\": [[1]]\n        }\n      ]\n    }\n  },\n  \"arcs\": [[[4000, 0], [1999, 9999], [2000, -9999], [2000, 9999]],[[0, 0], [0, 9999], [2000, 0], [0, -9999], [-2000, 0]]]\n}\n```\n## 3D Models\n```stl\nsolid cube_corner\n  facet normal 0.0 -1.0 0.0\n    outer loop\n      vertex 0.0 0.0 0.0\n      vertex 1.0 0.0 0.0\n      vertex 0.0 0.0 1.0\n    endloop\n  endfacet\n  facet normal 0.0 0.0 -1.0\n    outer loop\n      vertex 0.0 0.0 0.0\n      vertex 0.0 1.0 0.0\n      vertex 1.0 0.0 0.0\n    endloop\n  endfacet\n  facet normal -1.0 0.0 0.0\n    outer loop\n      vertex 0.0 0.0 0.0\n      vertex 0.0 0.0 1.0\n      vertex 0.0 1.0 0.0\n    endloop\n  endfacet\n  facet normal 0.577 0.577 0.577\n    outer loop\n      vertex 1.0 0.0 0.0\n      vertex 0.0 1.0 0.0\n      vertex 0.0 0.0 1.0\n    endloop\n  endfacet\nendsolid\n```\n## videos\n\u003cvideo src=\"https://github.com/rayytsn9/ROBOTT/assets/79029536/62f541aa-aa8c-43f5-9ead-4b7a2e0d7c2a\" width=\"300\" /\u003e\n\n## Math\n$`\\sqrt{3x-1}+(1+x)^2`$ $`Or`$ $`Just`$ $`This`$ $`Cool`$ $`Font`$\n\n## Math Blocks\n**The Cauchy-Schwarz Inequality**\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feymeen%2Fcool-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feymeen%2Fcool-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feymeen%2Fcool-markdown/lists"}