{"id":15551734,"url":"https://github.com/gwaredd/markdownasset","last_synced_at":"2025-04-23T20:45:23.011Z","repository":{"id":214664853,"uuid":"737065018","full_name":"gwaredd/MarkdownAsset","owner":"gwaredd","description":"An Unreal plugin that adds markdown as an asset type. This lets you embed documentation directly into your project.","archived":false,"fork":false,"pushed_at":"2025-01-14T10:04:48.000Z","size":6959,"stargazers_count":18,"open_issues_count":2,"forks_count":4,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-18T05:53:39.204Z","etag":null,"topics":["cpp","plugin","unreal","unreal-engine-5"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gwaredd.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,"zenodo":null}},"created_at":"2023-12-29T17:50:03.000Z","updated_at":"2025-03-07T01:36:11.000Z","dependencies_parsed_at":"2025-04-17T17:13:04.934Z","dependency_job_id":"d7c2420e-02bc-4092-9100-394ed82aa4be","html_url":"https://github.com/gwaredd/MarkdownAsset","commit_stats":{"total_commits":37,"total_committers":2,"mean_commits":18.5,"dds":0.2702702702702703,"last_synced_commit":"bbfac84d91dc79052ad1181bb1c2059cd864b3d3"},"previous_names":["gwaredd/markdownasset"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gwaredd%2FMarkdownAsset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gwaredd%2FMarkdownAsset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gwaredd%2FMarkdownAsset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gwaredd%2FMarkdownAsset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gwaredd","download_url":"https://codeload.github.com/gwaredd/MarkdownAsset/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250513380,"owners_count":21443200,"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":["cpp","plugin","unreal","unreal-engine-5"],"created_at":"2024-10-02T14:06:51.422Z","updated_at":"2025-04-23T20:45:22.976Z","avatar_url":"https://github.com/gwaredd.png","language":"HTML","readme":"# Markdown Asset\n\nA plugin for the Unreal game engine that adds Markdown as a new asset type.\n \n\u003e Unreal tested versions\n\u003e * 5.3\n\u003e * 5.4\n\u003e * 5.5\n\nThis allows you to create and manage documentation directly within the engine. This is particularly useful for personal projects and prototyping when you want to keep documentation with the project and close to hand.\n\n## How to install\n\n1. Clone this repo into your project's `Plugins` folder.\n2. Build your project\n3. Enable the Web Browser plugin (`Edit -\u003e Plugins` from the menu)\n4. Enable the Markdown Asset plugin (`Edit -\u003e Plugins` from the menu)\n\n## How to use\n\n### Create an asset\n\n* Right click in the content browser\n* `Documentation -\u003e Markdown Asset`\n\n![New markdown asset context menu](./Docs/NewAsset.png)\n\n### Edit an asset\n\n* Double click the asset to edit\n* This will open the asset in the editor\n* You can switch between the editor and preview mode using the button in the top right\n\n![View markdown](./Docs/Editing.png)\n\n### Settings\n\n* You can swap between a light and dark skin in the editor preferences\n* Edit -\u003e Editor Preferences -\u003e Plugins -\u003e Markdown Asset\n\n## Unreal Engine Links integration\n\nThe plugin uses the UAssetEditorSubsystem from the engine to open any asset from a link to it.\n\nYou can add links to your project assets, C++ file or even specific functions of a C++ class.\n\n![Unreal Engine Links](./Docs/LinksVariations.png)\n\n### How to link anything\n\nYou can directly copy and paste a reference to any asset or C++ file from the editor\n\n![Copy asset reference](./Docs/AssetReference.png)\n![Copy script reference](./Docs/ScriptReference.png)\n\nBecause Markdown files are assets too, you can reference them too! very useful to build one big index for your systems documentations\n\n![Copy reference](./Docs/MarkdownReference.png)\n\nYou can specify a function in a class link by adding \".FunctionName\" at the end, right before the last \"'\" character. When clicked, the default IDE will show the class at the specific function.\n\ni.e: to link the GetOwnerActor function inside the GameplayTask class the link is:\n\n```markdown\n/Script/CoreUObject.Class'/Script/GameplayTasks.GameplayTask.GetOwnerActor'\n```\n\n### Anatomy of a link to an asset\n\nThere are two important parts to link something from the engine: should starts with **\"/Script\"** and the actual link should be between two **'** characters after that.\n\n#### Examples of Valid links:\n\n*/Script/CoreUObject.Class'/Script/GameplayTasks.GameplayTask.GetOwnerActor'*\n\n*/Script '/Game/ThirdPerson/Maps/ThirdPersonMap.ThirdPersonMap'*\n\n### Hermes\n\nAlso supports [Hermes](https://github.com/jorgenpt/Hermes) and [RedTalaria](https://github.com/cdpred/RedTalaria) deeplinks.\n\n## Markdown Extensions\n\nThe editor runs inside the unreal web browser client. Under the hood it is using [markdown-it](https://github.com/markdown-it/markdown-it) and I've enabled a bunch of plugins that extend the markdown language with some extra goodies. Here's a quick rundown of what's available.\n\n### Syntax Highlighting\n\nShould be automatic for code blocks. You can specify the language like this:\n\n    ```c++\n    #include \"TestGamePlayerController.h\"\n    #include \"EnhancedInputSubsystems.h\"\n\n    void ATestGamePlayerController::BeginPlay()\n    {\n        Super::BeginPlay();\n    }\n    ```\n\n### Tasks Lists\n\nAre added like this:\n\n```markdown\n- [x] fix closing browser warning\n- [x] add custom icon\n- [ ] better editing experience\n- [ ] add dark and light themes\n```\n\nWhich gives this:\n\n![Create task list](./Docs/TaskList.png)\n\n\n### Anchors\n\nHeadings are automatically given anchors, so you can link to them like this:\n\n```markdown\n[Link](#ignore-extra-cells)\n\nwill jump to ...\n\n## Ignore extra cells\n```\n\n### Table of Contents\n\nYou can automatically add a table of contents to your document like this:\n\n```markdown\n[[toc]]\n```\n\n### MathJax\n\nYou can add math equations with [MathJax](https://www.mathjax.org/) by wrapping them with `$` or `$$`:\n\n#### Inline\n\n```markdown\n    $e^{i\\pi} - 1 = 0$\n```\n\n#### Block\n\n```markdown\n    $$\n    \\left( \\frac{\\partial^2}{\\partial x^2} + \\frac{\\partial^2}{\\partial y^2} \\right) {| \\varphi(x+ i y)|}^2 = 0\n    $$\n```\n\nGives ...\n\n![MathJax](./Docs/Math.png)\n\n\n### Diagrams\n\nDiagrams can be added with [GraphViz](https://graphviz.org/Gallery/directed/) (see [markdown-it-textual-uml](https://github.com/manastalukdar/markdown-it-textual-uml) for details).\n\nFor example:\n\n    ```plantuml\n    Bob -\u003e Alice : hello\n    ```\n\n    ```dot\n    digraph example1 {\n        1 -\u003e 2 -\u003e { 4, 5 };\n        1 -\u003e 3 -\u003e { 6, 7 };\n    }\n    ```\n\nWhich gives this:\n\n![GraphViz Diagrams](./Docs/Diagrams.png)\n\nPlantUML and Dot diagrams work fine. Ditaa and Mermaid, not so much.\n\n### Videos\n\nYou can embed videos from YouTube and Vimeo like this:\n\n```markdown\n@[youtube](tgbNymZ7vqY)\n@[youtube](http://www.youtube.com/embed/tgbNymZ7vqY)\n```\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgwaredd%2Fmarkdownasset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgwaredd%2Fmarkdownasset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgwaredd%2Fmarkdownasset/lists"}