brrd / abricotine

Markdown editor with inline preview
GNU General Public License v3.0
2.63k stars 156 forks source link

Metadata enhancements #222

Closed thj01 closed 5 years ago

thj01 commented 6 years ago

Is it possible to make a metadata section, which could translate into placeholders eg:

author email date web (authors web address) license keywords (tags) wordcount charactercount

example

::author: Thomas produces $author = Thomas

That would make it possible with HTML and CSS to insert this, and design advanced webcontent both for web wieving and PDF printing, that could be used in teaching context.

It would be awesome, if it could be done with a .json file so it was possible to make own extensions

example


author {
"metadata_string":"author",
"placeholder":"$author"
}
brrd commented 6 years ago

Is there any standardized way to do this in markdown? Maybe YAML headers (see #142)? I don't want to reinvent the wheel and Abricotine doesn't aim to create new standards.

thj01 commented 6 years ago

As i read it the YAML headers could do the trick ... I'm no programmer ... only at user/teacher

thx for the reply

dskopa-softdev commented 6 years ago

Using YAML frontmatter blocks for meta information right inside markdown files seems to be a common approach for this.

---
title: An Article
summary: A story about metadata
author: Some Author
creation_date: 2018-05-17
tags:
- metadata
- Abricotine
---

# What is this
Here goes the content of markdown file

In view mode this block can be hidden or displayed as a small grayed out text or whatever. When editing consider it's just a text block (for now)

I know Github, Hugo (md -> html site generator) and some other soft support frontmatter for storing metadata in markdown

seifferth commented 5 years ago

Actually, I believe that this issue is mostly resolved with YAML-support and the pandoc task (also see pull request #271 for generating complete documents with pandoc). Once #271 is merged, you should be able to simply save html files (with metadata included) using the pandoc task. It is also possible to save Word-Documents (docx) and many other formats by simply specifying the desired file extension. See also https://pandoc.org/MANUAL.html#option--to.

brrd commented 5 years ago

I merged #271. YAML header will be supported in next release by using pandoc (see @seifferth comment). Thanks.