TypeStrong / typedoc

Documentation generator for TypeScript projects.
https://typedoc.org
Apache License 2.0
7.71k stars 696 forks source link

typedoc output issues #792

Closed bluelovers closed 6 years ago

bluelovers commented 6 years ago

@example didn't output as code and line break

/**
 *
 * @example
 * charTableList('司马')
 * // => [ [ '司' ], [ '馬', '马' ] ]
 */
export function charTableList(text: string, options: IOptions = {})

2018-06-11-00-00-39-4

din't make link for import type

import { IOptions as IOptionsCjkConv } from '../convert';

export type IOptions = {
    optionsZhTable?: IOptionsZhTable,
    skip?,

    lang?: 'zh' | 'cn' | 'jp' | 'auto' | string,
}

2018-06-11-00-02-39-5

empty page

export { default as zhConvert, tw2cn, cn2tw } from './zh/convert/index';
export { default as zhTable, IOptions as IOptionsZhTable } from './zh/table/index';
export { default as jpConvert, zh2jp, jp2zht, jp2zhs, cjk2zht, cjk2zhs, cjk2jp } from './jp/index';

export { default as novelFilename } from './novel/filename';

import * as cjkConv from './index';
export default cjkConv;
aciccarello commented 6 years ago

For your first issue, use code fences with three backticks (like in markdown) to format code as a block. I believe your second issue is the same as #738

bluelovers commented 6 years ago

https://github.com/TypeStrong/typedoc/pull/805