Skip to content

Commit 923e895

Browse files
committed
Run markdownlint against generated docs and README.
1 parent e7f804e commit 923e895

4 files changed

Lines changed: 15 additions & 16 deletions

File tree

Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ deps-extra-apt:
99
lint:
1010
node_modules/.bin/jsonlint -d data/
1111
node_modules/.bin/yamllint .github/workflows/*.yaml
12-
mdl docs/
12+
mdl -r ~MD002,~MD013 docs/
13+
mdl -r ~MD002,~MD013,~MD033 *.md
1314

1415
build:
15-
node_modules/.bin/jazz-cli merge data/project-info.json templates/index.md.jazz > docs/index.md
16+
node_modules/.bin/jazz-cli merge data/project-info.json templates/index.md.jazz | head -c -1 > docs/index.md
1617

1718
.PHONY: ci deps deps-extra-apt lint build

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,6 @@
44
<br/>
55

66
oapicf.github.io
7-
----------------
7+
----------------
8+
9+
Website for OAPICF project at [https://oapicf.github.io](https://oapicf.github.io).

docs/index.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,22 @@
11
![OpenAPI Clients Factory](images/logo.png)
22

3-
A collection of generated API clients and utilities
3+
A collection of generated API clients and supporting utilities
44

55
### API Clients
6+
67
* [![Build Status](https://github.com/oapicf/endoflife.date-api-clients/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/endoflife.date-api-clients/actions?query=workflow%3ACI) [endoflife.date API Clients](https://github.com/oapicf/endoflife.date-api-clients) - Generated client libraries for [endoflife.date API](https://endoflife.date/docs/api)
7-
* [![Build Status](https://github.com/oapicf/minecraft-versions/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/minecraft-versions/actions?query=workflow%3ACI) [Minecraft Versions](https://github.com/oapicf/minecraft-versions) - Generated client libraries for [Minecraft Versions API](https://launchermeta.mojang.com)
8-
* [![Build Status](https://github.com/oapicf/openapi-azureipranges/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/openapi-azureipranges/actions?query=workflow%3ACI) [OpenAPI Azure IP Ranges](https://github.com/oapicf/openapi-azureipranges) - Generated client libraries for [Azure IP Ranges and Service Tags API](https://www.microsoft.com/en-us/download/details.aspx?id=56519)
8+
* [![Build Status](https://github.com/oapicf/minecraft-versions/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/minecraft-versions/actions?query=workflow%3ACI) [Minecraft Versions](https://github.com/oapicf/minecraft-versions) - Generated client libraries for [Minecraft Versions](https://minecraft.wiki/w/Version_history) info
9+
* [![Build Status](https://github.com/oapicf/openapi-azureipranges/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/openapi-azureipranges/actions?query=workflow%3ACI) [OpenAPI Azure IP Ranges](https://github.com/oapicf/openapi-azureipranges) - Generated client libraries for [Azure IP Ranges and Service Tags](https://www.microsoft.com/en-us/download/details.aspx?id=56519)
910
* [![Build Status](https://github.com/oapicf/openapi-ipify/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/openapi-ipify/actions?query=workflow%3ACI) [OpenAPI ipify](https://github.com/oapicf/openapi-ipify) - Generated client libraries for [ipify API](https://www.ipify.org)
10-
* [![Build Status](https://github.com/oapicf/openapi-iplocation/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/openapi-iplocation/actions?query=workflow%3ACI) [OpenAPI IP Location](https://github.com/oapicf/openapi-iplocation) - Generated client libraries for IP Location API
11+
* [![Build Status](https://github.com/oapicf/openapi-iplocation/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/openapi-iplocation/actions?query=workflow%3ACI) [OpenAPI IP Location](https://github.com/oapicf/openapi-iplocation) - Generated client libraries for [iplocation.net API](https://api.iplocation.net/)
1112
* [![Build Status](https://github.com/oapicf/openapi-okta-ip-ranges/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/openapi-okta-ip-ranges/actions?query=workflow%3ACI) [OpenAPI Okta IP Ranges](https://github.com/oapicf/openapi-okta-ip-ranges) - Generated client libraries for [Okta IP Ranges API](https://developer.okta.com/docs/reference/api/ip-ranges/)
1213
* [![Build Status](https://github.com/oapicf/openapi-openai/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/openapi-openai/actions?query=workflow%3ACI) [OpenAPI OpenAI](https://github.com/oapicf/openapi-openai) - Generated client libraries for [OpenAI API](https://platform.openai.com/docs/api-reference)
1314
* [![Build Status](https://github.com/oapicf/pinterest-sdk/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/pinterest-sdk/actions?query=workflow%3ACI) [Pinterest SDK](https://github.com/oapicf/pinterest-sdk) - Generated client libraries for [Pinterest API](https://developers.pinterest.com/docs/api/v5/)
1415
* [![Build Status](https://github.com/oapicf/pokeapi-clients/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/pokeapi-clients/actions?query=workflow%3ACI) [PokeAPI Clients](https://github.com/oapicf/pokeapi-clients) - Generated client libraries for [PokeAPI](https://pokeapi.co/docs/v2)
1516
* [![Build Status](https://github.com/oapicf/swaggy-jenkins/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/swaggy-jenkins/actions?query=workflow%3ACI) [Swaggy Jenkins](https://github.com/oapicf/swaggy-jenkins) - Generated client libraries for [Jenkins API](https://www.jenkins.io/doc/book/using/remote-access-api/)
1617

17-
1818
### Utilities
19+
1920
* [![Build Status](https://github.com/oapicf/swaggy-c/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/swaggy-c/actions?query=workflow%3ACI) [Swaggy C](https://github.com/oapicf/swaggy-c) - Builder for [OpenAPI Generator](https://openapi-generator.tech/)-generated API clients in multiple technology stacks
2021
* [![Build Status](https://github.com/oapicf/generator-openapi-generator/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/generator-openapi-generator/actions?query=workflow%3ACI) [Generator-OpenAPI-Generator](https://github.com/oapicf/generator-openapi-generator) - OpenAPI Generator projects generator using [Plop](https://plopjs.com/)
2122
* [![Build Status](https://github.com/oapicf/oapicf.github.io/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/oapicf.github.io/actions?query=workflow%3ACI) [oapicf.github.io](https://github.com/oapicf/oapicf.github.io) - Website for OAPICF project
22-
23-
24-
25-

templates/index.md.jazz

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
![{org.name}](images/logo.png)
22

33
{org.description}
4+
{foreach repo_group in repositories}
5+
### {repo_group.key}
46

5-
{foreach repo_group in repositories}### {repo_group.key}
67
{foreach repo in repo_group.value}* [![Build Status](https://github.com/{org.id}/{repo.id}/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/{org.id}/{repo.id}/actions?query=workflow%3ACI) [{repo.name}](https://github.com/{org.id}/{repo.id}) - {repo.description}
7-
{end}
8-
9-
{end}
8+
{end}{end}

0 commit comments

Comments
 (0)