CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl/npm-jsdoc-to-markdown

Generates markdown API documentation from JSDoc-annotated source code with comprehensive customization options

Overall
score

97%

Overview
Eval results
Files

rubric.jsonevals/scenario-4/

{
  "context": "This criteria evaluates how well the engineer uses jsdoc-to-markdown's partial template override functionality to customize parameter list rendering. The focus is entirely on correct usage of the package's template system, specifically the ability to override individual template partials while maintaining default behavior for other sections.",
  "type": "weighted_checklist",
  "checklist": [
    {
      "name": "Uses render method",
      "description": "Solution uses the jsdoc-to-markdown render() method to generate markdown documentation from the source file",
      "max_score": 15
    },
    {
      "name": "Creates custom partial",
      "description": "Solution creates a custom Handlebars partial template file to override the default parameter list rendering",
      "max_score": 25
    },
    {
      "name": "Configures partial option",
      "description": "Solution correctly passes the 'partial' option (or 'partials' option) to the render() method to register the custom partial template",
      "max_score": 20
    },
    {
      "name": "Custom format implementation",
      "description": "The custom partial template correctly formats parameters as **paramName** (*type*) - description using Handlebars syntax to access parameter data",
      "max_score": 25
    },
    {
      "name": "Selective override",
      "description": "Solution only overrides the parameter-related partial (such as 'params' or 'param-table-row') and does not override other template sections, allowing default rendering for other documentation elements",
      "max_score": 15
    }
  ]
}

Install with Tessl CLI

npx tessl i tessl/npm-jsdoc-to-markdown

tile.json