docsify icon indicating copy to clipboard operation
docsify copied to clipboard

Front-matter broken. Also add documentation

Open Kikobeats opened this issue 8 years ago • 9 comments

No idea what is the purpose of this plugin

Kikobeats avatar May 31 '17 08:05 Kikobeats

Actually I have not any idea what this plugin can do 😂

QingWei-Li avatar May 31 '17 13:05 QingWei-Li

https://github.com/egoist/docute/blob/0096fc1327b695f810ea652cb0adbe0c1cddccec/src/views/Page.vue#L273-L288

It overrides page attributes as far as I can tell.

jrappen avatar Oct 27 '17 22:10 jrappen

I would either document this properly or remove it so users don't waste their time chasing something that isn't usable.

WhileLoop avatar Apr 03 '18 20:04 WhileLoop

This is used to remove the front matter section that is located at the top of technical markdown documentation.

---
Title: XXX
Ref: 123
Authors: Some Guy
Created: 2018-05-24
---

cgatian avatar Nov 02 '18 13:11 cgatian

Just having come across this myself, how are the attributes from the front-matter used by Docsify? Are the attributes used at all by the core, or are they simple extracted to then be used by other plugins after the fact?

jthegedus avatar Jan 05 '19 08:01 jthegedus

Just having come across this myself, how are the attributes from the front-matter used by Docsify? Are the attributes used at all by the core, or are they simple extracted to then be used by other plugins after the fact?

I think it just strips them based on the comment above.

trusktr avatar Dec 08 '21 18:12 trusktr

Re-opening, this should be documented.

trusktr avatar Dec 08 '21 18:12 trusktr

Still no document about front-matter. And https://docsify.js.org/#/embed-files?id=markdown-with-yaml-front-matter gave a wrong example, in which the front-matter plugin didn't work. image

example-with-yaml.md: image

thomascatlee avatar Sep 28 '23 09:09 thomascatlee

Oh, yeah, that's broken! Anyone have time to fix this one?

trusktr avatar Sep 30 '23 02:09 trusktr