https://github.com/metalama/Metalama.Documentation
Documentation of Metalama aspect framework.
https://github.com/metalama/Metalama.Documentation
metalama
Last synced: 9 months ago
JSON representation
Documentation of Metalama aspect framework.
- Host: GitHub
- URL: https://github.com/metalama/Metalama.Documentation
- Owner: postsharp
- License: other
- Created: 2021-07-22T18:03:21.000Z (over 4 years ago)
- Default Branch: release/2024.2
- Last Pushed: 2024-10-25T14:48:09.000Z (over 1 year ago)
- Last Synced: 2024-10-25T15:46:34.338Z (over 1 year ago)
- Topics: metalama
- Language: C#
- Homepage: https://doc.metalama.net/
- Size: 17 MB
- Stars: 3
- Watchers: 5
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
---
created-date: 2023-02-02
modified-date: 2024-04-10
---
# Metalama.Documentation
This repository contains the documentation for Metalama. It is recommended to read it online at https://doc.metalama.net.
The 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.
## Building everything
To build everything, use the following command:
```powershell
.\Build.ps1 build
```
## Our Markdown extensions
### metalama-test
This markup includes an aspect test in a tab group. The target code is displayed as a side-by-side diff.
```
[!metalama-test [tabs=""] ]
```
where:
* `` represents a relative path, typically starting with `~`, where `~` is replaced by the root of the current repository.
* `` is a comma-separated list of one or more of the following values:
* `aspect`
* `target`
* `transformed`
* `output`
### metalama-compare
This markup displays source and transformed code side by side as a diff.
```
[!metalama-compare ]
```
where:
* `` represents a relative path, typically starting with `~`, where `~` is replaced by the root of the current repository.
### metalama-file
This markup includes a source file or a portion of it.
```
[!metalama-file [transformed] [marker='foo'] [member='']]
```
where:
* `` represents a relative path, typically starting with `~`, where `~` is replaced by the root of the current repository.
* `transformed` indicates that the transformed code should be displayed instead of the source code.
* `marker` indicates that only the code between lines with comments `/**/` and `/**/` should be included.
* `member` indicates that only the given member (provided in the form `TypeName.MemberName` without namespace) should be included.
### metalama-files
This markup creates a tab group with several files.
```
[!metalama-files ... [links="true|false"]]
```
where:
* `` ... `` represent relative paths, typically starting with `~`, where `~` is replaced by the root of the current repository.
* `links` indicates whether GitHub links should be generated.
### metalama-project-buttons
This markup generates buttons that open the entire directory in GitHub or in the sandbox.
```
[!metalama-project-buttons ]
```
where:
* `` represents a relative path to the directory.
### metalama-vimeo
This markup embeds a Vimeo video.
```
[!metalama-vimeo ]
```
where:
* `` represents the video ID.