vuepress / ecosystem

Official plugins and themes for VuePress2
https://ecosystem.vuejs.press
MIT License
28 stars 36 forks source link

[Feature request] GFM support in `@vuepress/markdown` #150

Closed Mister-Hope closed 3 months ago

Mister-Hope commented 2 years ago

Clear and concise description of the problem

I receive many users complaining that they are unable to use our tools to build a existing markdown folder in their project.

Mainly because we do not have full support of GFM.

It's good for us to support "standard" markdown files in GitHub.

Suggested solution

Add a new gfm option

Alternative

use vuepress-plugin-md-enhance with { gfm: true } option

meteorlxy commented 2 years ago

I'm planning to extract those md-it plugins to a standalone project

Mister-Hope commented 2 years ago

Any update with this one?

Mister-Hope commented 1 year ago

This one also needs review. @meteorlxy Answer these questions plz:

  1. Shall the GFM feature be added to @vuepress/markdown or a new plugin called @vuepress/plugin-gfm? OR just close this pr to let vuepress-plugin-md-enhance support this?

  2. What kind of GFM features shall we support? Additional thing including:

FootNote:

Footnote 1 link[^first].

Footnote 2 link[^second].

Inline footnote^[Text of inline footnote] definition.

Duplicated footnote reference[^second].

[^first]: Footnote can have markup

and multiple paragraphs.

[^second]: Footnote text.

Footnote 1 link[^first].

Footnote 2 link[^second].

Inline footnote^[Text of inline footnote] definition.

Duplicated footnote reference[^second].

[^first]: Footnote **can have markup**

    and multiple paragraphs.

[^second]: Footnote text.

Tasklists:

- [ ] item
- [x] item2
- [X] item3

Warning and note hints:

Note Some text here

Note: Some text here

Note: Some text here Addtional Content

Warning Some text here

Warning: Some text here

Warning: Some text here Addtional Content

> **Note**
> Some text here

> **Note**: Some text here

> **Note**: Some text here
> Addtional Content

> **Warning**
> Some text here

> **Warning**: Some text here

> **Warning**: Some text here
> Addtional Content

Rendering math fence and $$ blocks with mathjax

$$ a = 1 $$

```math
a = 1

$$ a = 1 $$

a = 1

Mermaid blocks with mermaid:

```mermaid
---
title: Flowchart
---
flowchart TB
    c1-->a2
    subgraph one
    a1-->a2
    end
    subgraph two
    b1-->b2
    end
    subgraph three
    c1-->c2
    end
    one --> two
    three --> two
    two --> c2
```mermaid
---
title: Flowchart
---
flowchart TB
    c1-->a2
    subgraph one
    a1-->a2
    end
    subgraph two
    b1-->b2
    end
    subgraph three
    c1-->c2
    end
    one --> two
    three --> two
    two --> c2

Image mark:

```md
![GitHub Light](/assets/image/github-light.svg#gh-dark-mode-only)
![GitHub Dark](/assets/image/github-dark.svg#gh-light-mode-only)

Some of the features would generate large chunks, so what do we need to support?

meteorlxy commented 4 months ago

Moving to ecosystem

github-actions[bot] commented 3 months ago

This issue is marked as stale because it has not had recent activity. Issues marked with stale will be closed if they have no activity within 7 days.

github-actions[bot] commented 3 months ago

This issue is marked as stale because it has not had recent activity. Issues marked with stale will be closed if they have no activity within 7 days.