File-level metadata in Markdown?

Đang mở
#95 14 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
json, markdown
Lĩnh vực
documentation

Hướng nghiên cứu

The issue proposes file-level metadata for Markdown using a new delimiter and JSON-like structure, but names no repository files, tests, or implementation entry point. Read the existing discussion and determine whether the project has a defined Markdown parser or metadata convention; the work is done only when the syntax and processing behavior are specified and accepted.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

I wonder if anyone's thought about a way to add file-level metadata to a Markdown document. In Frontier's website framework, we used a # to delimit a value, something like:

#title "My Test Page"

We have the same thing in HTML and OPML, in the <head> section:

<title>My Test Page</title>

The idea goes all the way back to C on Unix in the 70s:

#include "mymacros.h"

The directives are not part of the rendering. You don't see them when you read the document. But the values are available to software processing the document.

It seems since we're in The Age of JSON, something in JSON, delimited by a # might be appropriate?

#metadata = {
title: "Hello World",
tags: ["fun", "wisdom", "greetings"]
}

This just came up in a project I'm working on, but it's not the first time I've encountered it.

Ngôn ngữ chính
HTML
Star
134
Fork
10
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của scripting/Scripting-News

Tất cả issue của scripting/Scripting-News

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.