Commit 3c7b6715 authored by Ma_124's avatar Ma_124

Added README.md

parent 65d14021
Pipeline #46384065 passed with stages
in 2 minutes and 30 seconds
cmd/awesome/_test/outlist.md
.hooks/**
[![Build Status](https://gitlab.com/Ma_124/awesome-framework/badges/master/build.svg)](https://gitlab.com/Ma_124/awesome-framework/commits/master)
[![codecov](https://codecov.io/gl/Ma_124/awesome-framework/branch/master/graph/badge.svg)](https://codecov.io/gl/Ma_124/awesome-framework)
[![CodeCov](https://codecov.io/gl/Ma_124/awesome-framework/branch/master/graph/badge.svg)](https://codecov.io/gl/Ma_124/awesome-framework)
[![Go Report Card](https://goreportcard.com/badge/gitlab.com/Ma_124/awesome-framework)](https://goreportcard.com/report/gitlab.com/Ma_124/awesome-framework)
[![License MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://ma124.js.org/l/MIT/~/2019)
[![CII Best Practices](https://img.shields.io/cii/level/2506.svg)](https://bestpractices.coreinfrastructure.org/en/projects/2506)
[![Godoc](https://godoc.org/gitlab.com/Ma_124/awesome-framework?status.svg)](https://godoc.org/gitlab.com/Ma_124/awesome-framework)
[![License MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://ma124.js.org/l/MIT/~/2019)
# Awesome Framework
This is a framework for creating [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome/blob/master/awesome.md) lists.
It can convert [different filetypes](#filetypes) into each other and [fetch metadata](#fetch-metadata) about the repositories mentioned.
## Filetypes
### `markdown` (Input)
```md
+ lots
+ of
+ markdown
* [<name>](<url>) - <desc>
* [<name>](<url>) - <desc>
## Another Category
```
### `markdown` (+ `-html`) (Output)
```md
| Stars | Forks | Issues | Last Commit | Name | Desc |
|---------|---------|----------|---------------|-----------------|--------|
| <stars> | <forks> | <issues> | <last commit> | [<name>](<url>) | <desc> |
```
If you append `-html` the markdown will be compiled with [Blackfriday][].
### `simple-markdown` (+ `-html`) (Output)
```md
| Name | Desc |
|-----------------|--------|
| [<name>](<url>) | <desc> |
```
If you append `-html` the markdown will be compiled with [Blackfriday][].
### `tabsep` (Input/Output)
```
"literal line
'literal without newline
" continuation of previous line
<name>\t<url>\t<desc>
"""
block literal
which spans over
multiple lines
"""
```
## Fetch Metadata
Data Sources:
* https://github.com/example/repo
* http://github.com/example/repo
* https://godoc.org/github.com/example/repo
* http://godoc.org/github.com/example/repo
* https://gitlab.com/example/repo
* http://gitlab.com/example/repo
[Blackfriday]: https://github.com/russross/blackfriday
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment