Structured-Markdown / structured_markdown

Markdown with Structure and Style: Add an extra dimension to your markdown documents.
MIT License
6 stars 0 forks source link

More generalization of markdown structuring? #25

Open coevolving opened 4 years ago

coevolving commented 4 years ago

I discovered this project when searching on "structured markdown".

The scope of the project seems related more to separation of content (e.g. HTML) and presentation (e.g. CSS). I wonder if the scope might be more generalized.

On a parallel interest, I had discovered the Argdown project at https://argdown.org/ , that adds more semantics to Markdown. It's an interesting blend of approaches. Might this project think similarly?

ConradSchmidt commented 4 months ago

Same :D I arrived here with the same search term. Thanks for sharing your argdown finding :).

I'm not sure if Markdown isn't already able of what structured_markdown is doing, as you could use HTML, even though its a bit verbose. What do you think?

# Welcome

<div class="layer">

## New Layer

</div>

<style>.layer { color: red; }</style>

@coevolving as you search for the same term; I searched for it as Markdown is unstructured and I can't easily extract some meta data from it. I think the closest would be front-matter, but its another layer on top of MD content. I was also thinking using tags to structure the content, but this also feels a bit odd or at least not intuitive. And JSON/YAML are too technical formats to write content in it. By any chance did you find anything related to this?

The tag example could look like this and you could even leverage WebComponents:

# Welcome

<md-intro>

This is my welcome text for this page.

</md-intro>

<md-body>

Here is the main part of this page.

</md-body>

Then I could extract intro and body as e.g. JSON, which could be used to render a table of all pages and only show the intro as a short description.