Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

feat: shortcodes from template files

Đang mở
  • Có gì không ổn?
#36 0 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
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp, markdown
Lĩnh vực
content, tooling

Hướng nghiên cứu

Start with Fanstatic/Parsers/RefShortcodeParser.cs and the processing path in Page.cs:429, then inspect the existing shortcode tests in Fanstatic.Test/ and fixture sites in .TestSites/. Run ./build.sh test before changing behavior. Done means site and theme shortcode resolution, paired and Markdown-rendered forms, contextual parameters, clear unknown-shortcode errors, documentation examples, and passing ref/relref tests with the stated coverage and CRAP limits.

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

Mô tả

c:templates p:high size:M t:feature

Part of the Phase 3 epic (#33).

Current State

Only ref/relref shortcodes exist, hard-coded in Fanstatic/Parsers/RefShortcodeParser.cs, processed on raw
Markdown before Markdig (Page.cs:429).

Tasks:
  • Generalize the parser: {{< name arg1 key="v" >}} and paired {{< name >}}inner{{< /name >}}
  • Resolve shortcodes/<name>.html (site → theme); keep ref/relref as built-ins
  • Context: shortcode.Params (positional and named), shortcode.Inner, shortcode.Name, page, site
  • {{% name %}} form whose output is Markdown-rendered (Hugo semantics)
  • Unknown shortcode: clear error with page path and line
  • Docs page with examples

Tests live in Fanstatic.Test/ (xUnit + NSubstitute); fixture sites in .TestSites/. Run ./build.sh test; new/changed methods need CRAP ≤ 15 and ≥ 75 % line coverage.

Acceptance Criteria:
  • Fixture site with a youtube shortcode and a paired note shortcode renders correctly.
  • Existing ref/relref tests still pass.
Related:
  • #33 (Phase 3 epic, parent)
Ngôn ngữ chính
C#
Star
1
Fork
0
Merge trung bình
10 giờ 23 phút
Pull request đã merge (30 ngày)
4

Chuẩn bị môi trường

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 MASS4ORG/Fanstatic

Tất cả issue của MASS4ORG/Fanstatic

Issue tương tự

Thêm issue về C#

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.