clean-jsdoc-theme

LLM के साथ इस्तेमाल

यह theme LLMs के लिए बनाया गया है — हर page एक साथी .md और एक "copy / open in Claude · ChatGPT · Perplexity" button ship करता है। यह page उस कहानी का दूसरा आधा हिस्सा है: एक अकेली, downloadable skill file जो किसी भी assistant को सिखाती है कि clean-jsdoc-theme को ख़ुद कैसे इस्तेमाल और विस्तृत करें।

यह repo के SKILLS/ folder में SKILLS/clean-jsdoc-theme/SKILL.md के रूप में रहती है। इसे अपने coding assistant को सौंप दें और यह अनुमान लगाना बंद कर देता है — यह theme configure करता है, आपके guides लिखता है, और आपके sidebar को पहली ही बार सही ढंग से संरचित करता है।

जैसे-जैसे project बढ़ेगा, SKILLS/ वह जगह है जहाँ केंद्रित skills रहेंगी (प्रति-package skills, "build a guides site", "build an API reference", …)। आज यह umbrella clean-jsdoc-theme skill ship करता है जो नीचे की हर चीज़ को कवर करती है।

यह क्या है

SKILL.md एक स्वयं-निहित Markdown document है जो पूरे theme को एक ही जगह समेट लेता है — model की memory के नहीं, source के विरुद्ध verified। यह agent-skill format में लिखा गया है (एक name + description frontmatter block), इसलिए यह उन agents में सीधे गिर जाता है जो skills का समर्थन करते हैं, पर यह बस Markdown है: कोई भी LLM इसे पढ़ सकता है।

यह शुरू से अंत तक यह कवर करती है:

  • Setup — JSDoc और TypeDoc, न्यूनतम काम करने वाले configs के साथ।
  • हर configuration option — opts / cleanJsdocTheme reference, साथ ही JSDoc-only templates.default वाले।
  • Authoring — callouts, steps, tabs, embeds, और @category / @order / @iframe custom tags, उनके सटीक syntax नियमों के साथ।
  • docs directory और frontmatter — files कैसे pages बनती हैं।
  • sidebar model — एकल group/order engine और उसके सारे levers।
  • Cross-references और source links, LLM features, और theming।
  • package architecture (utils · setu · rang · dwar) उन सबके लिए जो internals विस्तृत करते हैं।
  • एक gotchas और troubleshooting section उन ग़लतियों के लिए जो assistants सबसे अधिक करते हैं।

यह क्यों मायने रखता है

clean-jsdoc-theme default JSDoc template नहीं है, और सामान्य "JSDoc theme" ज्ञान से काम करने वाला assistant विवरण ग़लत कर देगा — यह भूल जाएगा कि plugins/markdown ज़रूरी है, यह चूक जाएगा कि custom tags को allowUnknownTags चाहिए, या मान लेगा कि spaces एक @category path को nest करते हैं जबकि केवल / करता है।

skill को आगे रखना एक आगे-पीछे की बातचीत ("वह option मौजूद नहीं है…", "इसके बजाय यह आज़माएँ…") को एक सही पहले-ही उत्तर में बदल देता है। यह वही विचार है जो साथी .md के पीछे है जो theme आपके docs के लिए emit करता है — model को सच का स्रोत पहले दे दें और यह आपके project को उतनी ही धाराप्रवाह पढ़ता है जितना एक व्यक्ति पढ़ता है।

इसे कैसे इस्तेमाल करें

  1. 1
    Download it

    skill एक folder है — SKILLS/clean-jsdoc-theme/ — एक हल्की SKILL.md और माँग-पर (on-demand) reference/ files (assistant केवल वही हिस्सा पढ़ता है जो उसे चाहिए)। पूरा folder लें:

    CODE
    npx degit ankitskvmdam/clean-jsdoc-theme/SKILLS/clean-jsdoc-theme clean-jsdoc-theme

    या बस GitHub पर SKILL.md खोलें और उसे copy करें — SKILL.md अधिकांश सवालों के लिए स्वयं-पर्याप्त है और बाक़ी के लिए reference files से link करती है।

  2. 2
    Give it to your assistant

    जो भी आपके setup से मेल खाए उसे चुनें:

    यह एक तैयार-इस्तेमाल skill है। folder को अपनी project (या user) skills directory में डालें ताकि agent इसे — और इसकी reference/ files को — माँग पर load करे:

    CODE
    npx degit ankitskvmdam/clean-jsdoc-theme/SKILLS/clean-jsdoc-theme .claude/skills/clean-jsdoc-theme

    name / description frontmatter ही वह है जो agent को तय करने देता है कि इसे कब लागू करना है; फिर SKILL.md प्रति कार्य मेल खाती reference/ file खींचती है।

  3. 3
    Ask away

    "guides-only site के लिए jsdoc.json लिखें" से लेकर "मेरा @category दो groups क्यों दिखा रहा है?" तक — हर चीज़ का अब वह उत्तर मिलता है जो theme के वास्तव में काम करने के तरीके पर आधारित है।

इसे अद्यतन रखें

SKILL.md code के साथ-साथ versioned है (यह एक skill-revision stamp रखती है) और source के विरुद्ध verified है, इसलिए एक ताज़ा copy हमेशा उस theme से मेल खाती है जिस पर आप हैं। skill assistant को updates की जाँच करना भी सिखाती है — जब प्रासंगिक हो, और प्रति session अधिकतम एक बार, यह अपनी revision की तुलना published copy से और आपके installed theme version की तुलना npm के latest से करती है, और यदि कोई भी पीछे हो तो update करने की पेशकश करती है। theme upgrade करने के बाद नए options और features पाने के लिए इसे फिर से download करें।

यह भी देखें