{"id":20247673,"url":"https://github.com/metalama/Metalama.Documentation","last_synced_at":"2025-05-07T12:32:07.650Z","repository":{"id":37552367,"uuid":"388554236","full_name":"postsharp/Metalama.Documentation","owner":"postsharp","description":"Documentation of Metalama aspect framework.","archived":false,"fork":false,"pushed_at":"2024-10-25T14:48:09.000Z","size":17788,"stargazers_count":3,"open_issues_count":2,"forks_count":5,"subscribers_count":5,"default_branch":"release/2024.2","last_synced_at":"2024-10-25T15:46:34.338Z","etag":null,"topics":["metalama"],"latest_commit_sha":null,"homepage":"https://doc.metalama.net/","language":"C#","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/postsharp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2021-07-22T18:03:21.000Z","updated_at":"2024-10-24T16:17:52.000Z","dependencies_parsed_at":"2024-03-25T07:49:15.316Z","dependency_job_id":"f9282106-f845-4f74-8b63-72295980f90a","html_url":"https://github.com/postsharp/Metalama.Documentation","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postsharp%2FMetalama.Documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postsharp%2FMetalama.Documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postsharp%2FMetalama.Documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postsharp%2FMetalama.Documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/postsharp","download_url":"https://codeload.github.com/postsharp/Metalama.Documentation/tar.gz/refs/heads/release/2024.2","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224600205,"owners_count":17338446,"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":["metalama"],"created_at":"2024-11-14T09:38:43.890Z","updated_at":"2025-05-07T12:31:57.635Z","avatar_url":"https://github.com/postsharp.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ncreated-date: 2023-02-02\nmodified-date: 2024-04-10\n---\n\u003cp align=\"center\"\u003e\n\u003cimg width=\"450\" src=\"https://github.com/postsharp/Metalama/raw/master/images/metalama-by-postsharp.svg\" alt=\"Metalama logo\" /\u003e\n\u003c/p\u003e\n\n# Metalama.Documentation\n\nThis repository contains the documentation for Metalama. It is recommended to read it online at https://doc.metalama.net.\n\nThe code snippets in this documentation are located under the `code` subdirectory and are fully unit testable. Other examples are derived from the [Metalama.Samples](https://github.com/postsharp/Metalama.Samples) and [Metalama.Community](https://github.com/postsharp/Metalama.Community) repositories.\n\n## Building everything\n\nTo build everything, use the following command:\n\n```powershell\n.\\Build.ps1 build\n```\n\n\n## Our Markdown extensions\n\n### metalama-test\n\nThis markup includes an aspect test in a tab group. The target code is displayed as a side-by-side diff.\n\n```\n[!metalama-test \u003cpath\u003e [tabs=\"\u003ctabs\u003e\"] ]\n```\n\nwhere:\n\n* `\u003cpath\u003e` represents a relative path, typically starting with `~`, where `~` is replaced by the root of the current repository.\n* `\u003ctabs\u003e` is a comma-separated list of one or more of the following values:\n\n    * `aspect`\n    * `target`\n    * `transformed`\n    * `output`\n\n### metalama-compare\n\nThis markup displays source and transformed code side by side as a diff.\n\n```\n[!metalama-compare \u003cpath\u003e]\n```\n\nwhere:\n\n* `\u003cpath\u003e` represents a relative path, typically starting with `~`, where `~` is replaced by the root of the current repository.\n\n### metalama-file\n\nThis markup includes a source file or a portion of it.\n\n```\n[!metalama-file \u003cpath\u003e [transformed] [marker='foo'] [member='\u003cmember\u003e']]\n```\n\nwhere:\n\n* `\u003cpath\u003e` represents a relative path, typically starting with `~`, where `~` is replaced by the root of the current repository.\n* `transformed` indicates that the transformed code should be displayed instead of the source code.\n* `marker` indicates that only the code between lines with comments `/*\u003cFoo\u003e*/` and `/*\u003c/Foo\u003e*/` should be included.\n* `member` indicates that only the given member (provided in the form `TypeName.MemberName` without namespace) should be included.\n\n### metalama-files\n\nThis markup creates a tab group with several files.\n\n```\n[!metalama-files \u003cpath1\u003e \u003cpath2\u003e ... \u003cpath_n\u003e [links=\"true|false\"]]\n```\n\nwhere:\n\n* `\u003cpath1\u003e` ... `\u003cpath_n\u003e` represent relative paths, typically starting with `~`, where `~` is replaced by the root of the current repository.\n* `links` indicates whether GitHub links should be generated.\n\n### metalama-project-buttons\n\nThis markup generates buttons that open the entire directory in GitHub or in the sandbox.\n\n```\n[!metalama-project-buttons \u003cpath\u003e]\n```\n\nwhere:\n\n* `\u003cpath\u003e` represents a relative path to the directory.\n\n### metalama-vimeo\n\nThis markup embeds a Vimeo video.\n\n```\n[!metalama-vimeo \u003cid\u003e]\n```\n\nwhere:\n\n* `\u003cid\u003e` represents the video ID.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetalama%2FMetalama.Documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetalama%2FMetalama.Documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetalama%2FMetalama.Documentation/lists"}