https://github.com/suin/esa-markdown-format

esa.ioのMarkdownを自動整形する関数です
https://github.com/suin/esa-markdown-format

esa esa-io

Last synced: about 2 months ago
JSON representation

esa.ioのMarkdownを自動整形する関数です

• Host: GitHub
• URL: https://github.com/suin/esa-markdown-format
• Owner: suin
• License: mit
• Created: 2021-03-29T13:54:53.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-31T06:57:26.000Z (almost 4 years ago)
• Last Synced: 2024-11-07T11:12:00.952Z (2 months ago)
• Topics: esa, esa-io
• Language: TypeScript
• Homepage:
• Size: 246 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @suin/esa-markdown-format

esa.ioのMarkdownを自動整形する関数です。

## 特徴

- PrettierによるMarkdownの自動整形

- PrettierによるMarkdown内コードブロックの自動整形

- esa内部リンクを絶対URLから相対URLにする

どのような整形がなされるかの例は[自動整形のデモ](./demo)をご覧ください。

## インストール

```bash

yarn add @suin/esa-markdown-format

# or

npm install @suin/esa-markdown-format

```

## 使い方

`format`関数にフォーマットしたいMarkdownとチーム名を渡すと、フォーマットされたMarkdownが返ります:

```ts

import format from "@suin/esa-markdown-format";

const input = `

ヘッダ

=====

* リスト

* リスト

|カラム1|カラム2|カラム3|

|---|---|---|

|a|b|c|

~~~js

const uglyCode=function(){return 'omg'}

~~~

    const indented = "code";

[絶対URL](https://example.esa.io/posts/1)`;

const output = format(input, { team: "example" });

```

`output`の内容:

````markdown

# ヘッダ

- リスト

- リスト

| カラム1 | カラム2 | カラム3 |

| ------- | ------- | ------- |

| a       | b       | c       |

```js

const uglyCode = function () {

  return "omg";

};

```

```

const indented = "code";

```

[絶対URL](/posts/1)

````

## API リファレンス

https://suin.github.io/esa-markdown-format/