Skip to content

Commit

Permalink
Add markdown linting (#19)
Browse files Browse the repository at this point in the history
* Add markdown linting

* Update blank.yml

* Update ci

* fix ci

* fix linting issues
  • Loading branch information
kaypee90 authored Mar 28, 2024
1 parent 9bf6c25 commit 0d65080
Show file tree
Hide file tree
Showing 2 changed files with 116 additions and 26 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/blank.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# This is a basic workflow to help you get started with Actions

name: CI

# Controls when the workflow will run
on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
lint-changelog:
name: Lint README.md file
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v2

- name: Lint README file
uses: avto-dev/markdown-lint@v1
with:
args: './README.md'
118 changes: 92 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,97 +2,163 @@

- [Contributing](#contributing)

### List of awesome open standards
## List of awesome open standards

### [Cloud Events](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md)
- CloudEvents is a specification for describing event data in common formats to provide interoperability across services, platforms and systems.

- CloudEvents is a specification for describing event data
in common formats to provide interoperability across services,
platforms and systems.

### [GeoJSON](https://datatracker.ietf.org/doc/html/rfc7946)

- GeoJSON is a geospatial data interchange format based on JavaScript
Object Notation (JSON). It defines several types of JSON objects and
the manner in which they are combined to represent data about
geographic features, their properties, and their spatial extents.

### [HTML](https://html.spec.whatwg.org/multipage/)
- HTML is the World Wide Web's core markup language. Originally, HTML was primarily designed as a language for semantically describing scientific documents.

- HTML is the World Wide Web's core markup language. Originally, HTML was
primarily designed as a language for semantically describing scientific documents.

### [HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP)
- Hypertext Transfer Protocol (HTTP) is an application-layer protocol for transmitting hypermedia documents, such as HTML.

- Hypertext Transfer Protocol (HTTP) is an application-layer protocol
for transmitting hypermedia documents, such as HTML.

### [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
- ISO 8601 tackles this uncertainty by setting out an internationally agreed way to represent dates.

- ISO 8601 tackles this uncertainty by setting out an internationally
agreed way to represent dates.

### [JSON](https://www.json.org/json-en.html)

- JSON (JavaScript Object Notation) is a lightweight data-interchange format.

### [JSON Schema](https://json-schema.org/)

- JSON Schema is the vocabulary that enables JSON data consistency

### [Markdown](https://www.markdownguide.org/getting-started/)
- Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents.

- Markdown is a lightweight markup language that you can use to
add formatting elements to plaintext text documents.

### [OAuth](https://oauth.net/2/)

- OAuth 2.0 is the industry-standard protocol for authorization.

### [ODBC](https://en.wikipedia.org/wiki/Open_Database_Connectivity)
- In computing, Open Database Connectivity (ODBC) is a standard application programming interface (API) for accessing database management systems (DBMS).

- In computing, Open Database Connectivity (ODBC) is a standard
application programming interface (API) for accessing database
management systems (DBMS).

### [Open API](https://www.openapis.org/)

- The OpenAPI Specification provides a formal standard for describing HTTP APIs.

### [Open Container Initiative](https://opencontainers.org/)
- The Open Container Initiative is an open governance structure for the express purpose of creating open industry standards around container formats and runtimes.

- The Open Container Initiative is an open governance structure
for the express purpose of creating open industry standards
around container formats and runtimes.

### [Open Data](https://en.wikipedia.org/wiki/Open_data)
- Open data is data that is openly accessible, exploitable, editable and shared by anyone for any purpose. Open data is licensed under an open license.

- Open data is data that is openly accessible, exploitable, editable
and shared by anyone for any purpose. Open data is licensed under an open license.

### [Open Document](https://opendocumentformat.org/)
- OpenDocument Format provides a comprehensive solution to exchange documents reliably and effortlessly across different products and devices.

- OpenDocument Format provides a comprehensive solution to
exchange documents reliably and effortlessly across different products and devices.

### [Open Font Format](https://www.iso.org/standard/52136.html#:~:text=The%20Open%20Font%20Format%20is,or%20CFF%20(PostScript)%20outlines.)
- The Open Font Format is an extension of the TrueType font format, adding support for PostScript font data.

- The Open Font Format is an extension of the TrueType font format,
adding support for PostScript font data.

### [Open SSH](https://www.openssh.com/)
- OpenSSH is the premier connectivity tool for remote login with the SSH protocol. It encrypts all traffic to eliminate eavesdropping, connection hijacking, and other attacks. In addition, OpenSSH provides a large suite of secure tunneling capabilities, several authentication methods, and sophisticated configuration options.

- OpenSSH is the premier connectivity tool for remote
login with the SSH protocol. It encrypts all traffic
to eliminate eavesdropping, connection hijacking,
and other attacks. In addition, OpenSSH provides
a large suite of secure tunneling capabilities,
several authentication methods, and sophisticated
configuration options.

### [Open Telemetry](https://opentelemetry.io/)
- OpenTelemetry is a collection of APIs, SDKs, and tools. Use it to instrument, generate, collect, and export telemetry data (metrics, logs, and traces) to help you analyze your software’s performance and behavior.

- OpenTelemetry is a collection of APIs, SDKs, and tools.
Use it to instrument, generate, collect, and
export telemetry data (metrics, logs, and traces)
to help you analyze your software’s performance and behavior.

### [OpenGL](https://www.opengl.org/)
- OpenGL (Open Graphics Library) is a cross-language, cross-platform application programming interface (API) for rendering 2D and 3D vector graphics.

- OpenGL (Open Graphics Library) is a cross-language,
cross-platform application programming interface (API)
for rendering 2D and 3D vector graphics.

### [OpenID Connect](https://openid.net/developers/how-connect-works/)
- OpenID Connect is an interoperable authentication protocol based on the OAuth 2.0 framework of specifications (IETF RFC 6749 and 6750). It simplifies the way to verify the identity of users based on the authentication performed by an Authorization Server and to obtain user profile information in an interoperable and REST-like manner.

- OpenID Connect is an interoperable authentication protocol based on
the OAuth 2.0 framework of specifications (IETF RFC 6749 and 6750).
It simplifies the way to verify the identity of users based on
the authentication performed by an Authorization Server and to
obtain user profile information in an interoperable and REST-like manner.

### [OpenMP](https://www.openmp.org/)
- OpenMP (Open Multi-Processing) is an application programming interface (API) that supports multi-platform shared-memory multiprocessing programming in C, C++, and Fortran,[3] on many platforms, instruction-set architectures and operating systems, including Solaris, AIX, FreeBSD, HP-UX, Linux, macOS, and Windows.

- OpenMP (Open Multi-Processing) is an application programming interface
(API) that supports multi-platform shared-memory multiprocessing programming
in C, C++, and Fortran,[3] on many platforms, instruction-set architectures
and operating systems, including Solaris, AIX, FreeBSD, HP-UX, Linux, macOS,
and Windows.

### [OpenSSL](https://www.openssl.org/)
- The OpenSSL Project develops and maintains the OpenSSL software - a robust, commercial-grade, full-featured toolkit for general-purpose cryptography and secure communication

- The OpenSSL Project develops and maintains the OpenSSL
software - a robust, commercial-grade, full-featured
toolkit for general-purpose cryptography and secure communication

### [OpenXLA](https://github.com/openxla)
- A community-driven, open source ML compiler ecosystem, using the best of XLA & MLIR.

- A community-driven, open source ML compiler ecosystem,
using the best of XLA & MLIR.

### [POSIX](https://www.linux.org/)
- POSIX (Portable Operating System Interface) is a set of standard operating system interfaces based on the Unix operating system

- POSIX (Portable Operating System Interface) is a set of standard operating
system interfaces based on the Unix operating system

### [Protocol Buffers](https://protobuf.dev/)
- Protocol Buffers are language-neutral, platform-neutral extensible mechanisms for serializing structured data.

- Protocol Buffers are language-neutral, platform-neutral extensible mechanisms
for serializing structured data.

### [URI](https://datatracker.ietf.org/doc/html/rfc3986)
- A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource.

- A Uniform Resource Identifier (URI) is a compact sequence of characters
that identifies an abstract or physical resource.

### [Web Assembly](https://webassembly.org/)
- WebAssembly (abbreviated Wasm) is a binary instruction format for a stack-based virtual machine.

- WebAssembly (abbreviated Wasm) is a binary instruction format
for a stack-based virtual machine.

### [XML](https://aws.amazon.com/what-is/xml/)
- Extensible Markup Language (XML) lets you define and store data in a shareable manner.

- Extensible Markup Language (XML) lets you define and store data in a
shareable manner.

### [YAML](https://yaml.org/)
- YAML is a human-friendly data serialization language for all programming languages.

<br>
- YAML is a human-friendly data serialization language for all programming languages.

# Contributing
## Contributing

Your contributions are always welcome. Create a PR for a popular open standard.

0 comments on commit 0d65080

Please sign in to comment.