iissnan / iissnan/theme-next-docs

请求开发文档

Open
#178 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
165
Forks
55
PR merge metrics
No merged PRs in 30d

Description

## 需要的内容
文档是否可以详细地把这个主题的文件结构,代码地图描述出来?
现在的这个文档是个使用文档对吧,那么开发文档在哪里?我没有找到。
## 需求初衷
你们的 [readme](https://github.com/iissnan/hexo-theme-next/blob/master/README.md) 上写了:
>## 贡献 Contributing
>接受各种形式的贡献,包括不限于提交问题与需求,修复代码。等待您的`Pull Request`。

但是,我根本不清楚你的设计逻辑我怎么贡献?而且更重要的一点是我想自定义这个模板,添加自己想要的组件,但是无从下手,不知道各个目录之间的逻辑,实现的代码也不知道该去哪里调用。
## 我研究的结果
我研究了 Hexo 模板 API 和 SWIG 语法之后,对这个主题的架构有了一些整体上的认识,但是如果开发者能够写一份手册,直截了当地把目录结构的逻辑和调用/回调树展示出来,将会极大地降低学习成本!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with README.md, then review the Hexo template API and SWIG syntax referenced in the issue. Document the theme's directory structure, component relationships, and invocation or callback flow; done means a developer can locate the relevant code and understand where to add custom components.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
18/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.