Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

feat: shortcodes from template files

未关闭
#36 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
csharp, markdown
领域
content, tooling

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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)
主要语言
C#
星标
1
派生
0
平均合并
13 小时 50 分钟
30 天内合并 PR
3

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

MASS4ORG/Fanstatic 的其他 Issue

查看 MASS4ORG/Fanstatic 的全部 Issue

相似的 Issue

更多 C# Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。