{"id":16579431,"url":"https://github.com/brianpeiris/aframe-markdown","last_synced_at":"2025-09-04T13:36:32.069Z","repository":{"id":57174221,"uuid":"161444045","full_name":"brianpeiris/aframe-markdown","owner":"brianpeiris","description":"Render Markdown using SDF text in A-Frame.","archived":false,"fork":false,"pushed_at":"2019-01-06T18:33:00.000Z","size":17400,"stargazers_count":20,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-06T23:57:20.427Z","etag":null,"topics":["aframe","markdown"],"latest_commit_sha":null,"homepage":"https://brianpeiris.github.io/aframe-markdown/demos/","language":"JavaScript","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/brianpeiris.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}},"created_at":"2018-12-12T06:39:43.000Z","updated_at":"2021-09-20T15:28:05.000Z","dependencies_parsed_at":"2022-09-02T12:11:23.530Z","dependency_job_id":null,"html_url":"https://github.com/brianpeiris/aframe-markdown","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brianpeiris%2Faframe-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brianpeiris%2Faframe-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brianpeiris%2Faframe-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brianpeiris%2Faframe-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brianpeiris","download_url":"https://codeload.github.com/brianpeiris/aframe-markdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238777397,"owners_count":19528813,"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":["aframe","markdown"],"created_at":"2024-10-11T22:17:58.772Z","updated_at":"2025-02-14T03:32:07.657Z","avatar_url":"https://github.com/brianpeiris.png","language":"JavaScript","readme":"# aframe-markdown\n\n[![](https://img.shields.io/npm/v/aframe-markdown.svg)](https://www.npmjs.com/package/aframe-markdown)\n\nRenders Markdown using SDF text in A-Frame.\n\nDemos: https://brianpeiris.github.io/aframe-markdown/demos/\n\nGlitch: https://aframe-markdown.glitch.me/\n\n![screen shot of basic demo](demos/basic-screenshot.jpg)\n\n## Usage\n\n```html\n\u003ca-scene \n  markdown=\"\n    normalFont: https://unpkg.com/aframe-markdown/fonts/Roboto-msdf.json; \n    boldFont: https://unpkg.com/aframe-markdown/fonts/Roboto-Bold-msdf.json;\n  \"\n\u003e\n  \u003ca-assets\u003e\n\t\u003ca-asset-item id=\"md\" src=\"test.md\"\u003e\u003c/a-asset-item\u003e\n  \u003c/a-assets\u003e\n  \u003ca-entity markdown=\"src: #md\" position=\"0 1.5 -1\"\u003e\u003c/a-entity\u003e\n\u003c/a-scene\u003e\n```\n\n## Component Properties\n\n|Properties|Description|Default|\n|-|-|-|\n|src|The source for the markdown to render. Either the actual markdown text, or a selector to an a-asset-item that loads the markdown||\n|wrapCount|Number of characters before wrapping text (more or less).|40|\n|padding|Padding in meters between the background and the text|0.05|\n\n## System Properties\n\n|Properties|Description|Default|\n|-|-|-|\n|normalFont|URL to the msdf.json file for the normal weight font||\n|normalFont|URL to the msdf.json file for the bold font||\n\n## Supported Markdown Features\n\naframe-markdown supports a basic subset of markdown.\n\n- [x] Paragraphs\n  - [x] Line breaks\n- [x] Headers\n- [x] Images\n- [x] Lists\n  - [x] Nested lists\n  - [x] Unordered lists\n  - [x] Ordered lists\n- [ ] Inline bold and italic formatting\n- [ ] Blockquotes\n- [ ] Horizontal rules\n- [ ] Tables\n- [ ] Code\n  - [ ] Inline code\n  - [ ] Code blocks\n- [ ] Links\n\n## How it works\n\naframe-markdown uses a hidden div and marked.js to render the markdown in the background and then re-creates the \nrendered in a-frame using the HTML's metrics.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianpeiris%2Faframe-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrianpeiris%2Faframe-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianpeiris%2Faframe-markdown/lists"}