mirror of
https://github.com/nunocoracao/blowfish.git
synced 2025-02-02 11:32:30 -06:00
[ADD] Gitlab shortcut documentation
This commit is contained in:
parent
c1aca647c7
commit
d335c7dc71
1 changed files with 25 additions and 1 deletions
|
@ -296,7 +296,7 @@ In order to add images to the gallery, use `img` tags for each image and add `cl
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
<!-- prettier-ignore-start -->
|
||||||
| Parameter | Description |
|
| Parameter | Description |
|
||||||
| --------- | ----------------------------------------------------- |
|
|-----------|-------------------------------------------------------|
|
||||||
| `repo` | [String] github repo in the format of `username/repo` |
|
| `repo` | [String] github repo in the format of `username/repo` |
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
|
||||||
|
@ -310,6 +310,30 @@ In order to add images to the gallery, use `img` tags for each image and add `cl
|
||||||
|
|
||||||
<br/><br/><br/>
|
<br/><br/><br/>
|
||||||
|
|
||||||
|
## GitLab Card
|
||||||
|
|
||||||
|
`gitlab` allows you to quickly link a GitLab Project (GitLab's jargon for repo).
|
||||||
|
It displays realtime stats about it, such as the number of stars and forks it has.
|
||||||
|
Unlike `github` it can't display the main programming language of a project.
|
||||||
|
Finaly custom GitLab instace URL can be provided, as long as the `api/v4/projects/` endpoint is available, making this shortcode compatible with most self-hosted / entreprise deployments.
|
||||||
|
|
||||||
|
<!-- prettier-ignore-start -->
|
||||||
|
| Parameter | Description |
|
||||||
|
|-------------|------------------------------------------------------------------------|
|
||||||
|
| `projectID` | [String] gitlab numeric ProjectID |
|
||||||
|
| `baseURL` | [String] optional gitlab instace URL, default is `https://gitlab.com/` |
|
||||||
|
<!-- prettier-ignore-end -->
|
||||||
|
|
||||||
|
**Example 1:**
|
||||||
|
|
||||||
|
```md
|
||||||
|
{{</* gitlab projectID="278964" */>}}
|
||||||
|
```
|
||||||
|
|
||||||
|
{{< gitlab projectID="278964" >}}
|
||||||
|
|
||||||
|
<br/><br/><br/>
|
||||||
|
|
||||||
## Icon
|
## Icon
|
||||||
|
|
||||||
`icon` outputs an SVG icon and takes the icon name as its only parameter. The icon is scaled to match the current text size.
|
`icon` outputs an SVG icon and takes the icon name as its only parameter. The icon is scaled to match the current text size.
|
||||||
|
|
Loading…
Reference in a new issue