aboutcode-org / aboutcode-org/scancode-toolkit

Add option to export scan results as "markdown"

未關閉
#3,017 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
GUI and outputs new feature
主要語言
Python
星號
2.6k
分支
791
平均合併
1 天 12 小時
30 天內合併 PR
5

描述

## Short Description

As a user, I would like a command line option (e.g. `--markdown`) so that I can export the scan results in "markdown" format. This would enable the user to upload these markdown pages to a github wiki.

## Possible Labels

- new feature

## Select Category

- [x] Enhancement
- [ ] Add License/Copyright
- [ ] Scan Feature
- [ ] Packaging
- [ ] Documentation
- [ ] Expand Support
- [ ] Other

## **Describe the Update**

At the moment, there is already support for exporting scan results to JSON, CSV, HTML, and to a customize template. Being that markdown is one of the most popular formats used by programmers to document things in their repositories and wikis, it would be nice to have a quick way of doing this rather than have to create a custom template. I have tried converting HTML to markdown with a few different python libraries and it never converts properly mainly because the usage of the `` tag in the HTML format and it also leaves CSS styling in the page.

## **How This Feature will help you/your organization**

This would allow me to commit the scan results to a wiki page (which renders markdown), for example, to github's wikis.

## **Possible Solution/Implementation Details**

1. Add a new command line option such as `--markdown FILE` that will format the scan results accordingly; or,
2. Modify the HTML formatting so that it can better converted by (python) libraries like `markdownify` or `html2markdown`.

## **Example/Links if Any**

```
docker run -v $PWD/:/output scancode-toolkit -clpeui --processes 4 --markdown /output/$FILENAME /output
```

## **Can you help with this Feature**

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。