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-3/

{
  "context": "This evaluation assesses the engineer's ability to use jsdoc-to-markdown's cross-platform compatibility features, specifically the EOL option for controlling line endings and the no-gfm option for controlling markdown format. The focus is on proper usage of these package-specific options to generate documentation that meets platform-specific requirements.",
  "type": "weighted_checklist",
  "checklist": [
    {
      "name": "Uses render method",
      "description": "Solution calls the jsdoc-to-markdown render() method to generate markdown documentation from JSDoc-annotated source files",
      "max_score": 25
    },
    {
      "name": "EOL option usage",
      "description": "Solution uses the 'EOL' option parameter in the render() method call to control line ending format, setting it to 'posix' for POSIX line endings or 'win32' for Windows line endings based on the lineEndings configuration",
      "max_score": 35
    },
    {
      "name": "no-gfm option usage",
      "description": "Solution uses the 'no-gfm' option parameter in the render() method call to control whether GitHub-flavored markdown is used, setting it to true when generic markdown is requested and false (or omitting it) for GitHub-flavored markdown",
      "max_score": 30
    },
    {
      "name": "File output handling",
      "description": "Solution writes the generated markdown content to the specified output file path using appropriate file system operations",
      "max_score": 10
    }
  ]
}

Install with Tessl CLI

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

tile.json