Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyokomi/excel-to-markdown
excel to markdown convert tool
https://github.com/kyokomi/excel-to-markdown
Last synced: 3 months ago
JSON representation
excel to markdown convert tool
- Host: GitHub
- URL: https://github.com/kyokomi/excel-to-markdown
- Owner: kyokomi
- License: mit
- Created: 2014-09-07T02:27:26.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-02-03T20:13:59.000Z (almost 5 years ago)
- Last Synced: 2024-06-18T23:04:44.298Z (5 months ago)
- Language: Go
- Size: 40 KB
- Stars: 59
- Watchers: 4
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Excel-to-Markdown
====================================
## Description
used at GitHub, the format is GitHub-Flavoured Markdown; see:
https://help.github.com/articles/github-flavored-markdown/
## Usage
### Building
* `export GOPATH=`
* `go get` to download the github dependency
* `go build` to build the executable
### Help
```
$ ./excel-to-markdown help
NAME:
excel-to-markdown -
USAGE:
excel-to-markdown [global options] command [command options] [arguments...]
VERSION:
0.1.0
AUTHOR:
kyokomi -
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--input-dir, -i convert target directory path
--output-dir, -o dist directory after convert path
--help, -h show help
--version, -v print the version
```
### Running
```
$ ./excel-to-markdown --input-dir example/excel --output-dir example/build
```
## Demo
### Input `.xlsx`
[sample](https://github.com/kyokomi/excel-to-markdown/blob/master/example/excel/sample.xlsx)
### Output `.md`
[sample](https://github.com/kyokomi/excel-to-markdown/blob/master/example/build/sample/sheet1.md)
```
# GoでExcelをMarkdownにする
## 目的とゴール
まずExcelで仕様を管理しているが、変更が多すぎるわりに変更管理がちゃんとできていない。レビューの体制もちゃんと取れないという問題がある。
エンジニアも見やすく、差分管理も楽なMarkdownで書いてくれれば一番良いのだが、この手の新しい取り組みは、よほど儲かっていて時間や人に余裕がある会社しかなかなかできないと思われる。
（弊社がまさにそれで、そんなことやってる場合があったら〜とよく一蹴される。やったほうが後々の効率は良くなるという説明も無駄に等しい）
となると、こちらから歩みよるしかなくて、Excelがつかいたいのは譲るが文章のフォーマットは整えてもらいそれをMarkdownに変換することにした。
## メリット
- 変更履歴を自動的に管理できるようになる
- 仕様書もレビューできるようになる
## デメリット
- フォーマットが矯正されて少しExclelが使いにくくなる
- 図やシェイプなどが使えない（使ってもいいけどMarkdown変換できない）
- 色等の視覚情報での説明ができない
- 画像のリンクを置くのがめんどくさそう
## 対応が必要なフォーマット
|No|フォーマット|ルール|
| --- | --- | --- |
|1|タイトル見出し|シートの1行目が#見出し|
|2|区切りの見出し|空白行の後が##見出し|
|3|リスト表示|1セル目が空白|
|4|表形式の表示|2セル以上の利用|
|5|画像の表示|先頭「http〜の」、先頭「/」とかパスっぽいやつ|
|6|本文（通常）|上記以外|
## ゴーファー君
```
## Author
[kyokomi](https://github.com/kyokomi)
## License
[MIT](https://github.com/kyokomi/excel-to-markdown/blob/master/LICENSE)