The typedoc-nextra from neplextech

Parsing breaks on using inline `code`

Hey, thanks for this library. I was looking for a good (basically not ugly) typedoc theme when I stumbled across this repo and this looks perfect.

I ran into a couple of issues, one of which is when using inline code blocks like abc, the parsing is not correct.

This is what I have in my tsdoc comment:

/**
 * Get list of mutual fund orders.
 *
 * @param order_id ID of the order (optional) whose order details are to be retrieved.
 * If no `order_id` is specified, all orders for the day are returned.
 */
 getMFOrders(order_id?: string): Promise<MFOrder | MFOrder[]> {
  if (order_id) {
    return this._get(
      'mf.order.info',
      { order_id: order_id },
      null,
      this.formatResponse
    );
  } else {
    return this._get('mf.orders', null, null, this.formatResponse);
  }
}

I am expecting something like this:

But this is what is being generated:

- [Source](https://github.com/anurag-roy/kiteconnect-ts/blob/327f526/lib/connect/index.ts#L1136)
### public  getMFOrders(order_id?): Promise\<MFOrder \| Array\<MFOrder>>
Get list of mutual fund orders.




| Parameter | Type | Optional | Description |
| ----------- | ----------- | ----------- | ----------- |
| order_id | string | ✅ | ID of the order (optional) whose order details are to be retrieved.
If no |

For reference, this is the json structure being generated by typedoc:

{
  "id": 263,
  "name": "getMFOrders",
  "kind": 2048,
  "kindString": "Method",
  // ...
  "signatures": [
    {
      "id": 264,
      "name": "getMFOrders",
      "kind": 4096,
      "kindString": "Call signature",
      "flags": {},
      "comment": {
        "summary": [
          {
            "kind": "text",
            "text": "Get list of mutual fund orders."
          }
        ]
      },
      "parameters": [
        {
          "id": 265,
          "name": "order_id",
          "kind": 32768,
          "kindString": "Parameter",
          "flags": {
            "isOptional": true
          },
          "comment": {
            "summary": [
              {
                "kind": "text",
                "text": "ID of the order (optional) whose order details are to be retrieved.\nIf no "
              },
              {
                "kind": "code",
                "text": "`order_id`"
              },
              {
                "kind": "text",
                "text": " is specified, all orders for the day are returned."
              }
            ]
          },
          "type": {
            "type": "intrinsic",
            "name": "string"
          }
        }
      ]
      // ...
    }
  ]
}

Looking at signatures[0].parameters[0].comment.summary, I think we are just taking into account the first element of the array which might be the problem here.

If you want more context, this is the repo I'm working on. Thanks!

Markdown Files Not Being Outputted

This package looks very promising, but I can't seem to get it to work.

I have the following code for docgen.mjs, but the markdown files don't seem to be created.

import { createDocumentation } from 'typedoc-nextra';

await createDocumentation({
  jsonInputPath: `${process.cwd()}/out.json`,
  tsconfigPath: `${process.cwd()}/../../packages/handler/tsconfig-base.json`,
  output: `${process.cwd()}/pages/docs`,
  markdown: true,
});

Also, I had another issue whenever I try to do typedoc with npx/pnpx. It would say error Invalid structure in plugin typedoc-nextra, no load function found.

neplextech / typedoc-nextra Goto Github PK

typedoc-nextra's People

Contributors

Stargazers

Watchers

Forkers

typedoc-nextra's Issues

Issue with types linker

Parsing breaks on using inline `code`

Markdown Files Not Being Outputted

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent