Coder Social home page Coder Social logo

Comments (6)

tgreyuk avatar tgreyuk commented on June 29, 2024

Hello.

I have mocked up a page for this and it does appear to render correctly with my tests (https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/tests/mocks/default/modules/_doc_comments_.md).

Could I please confirm that you are using the latest version of the plugin? If you are using the latest version then please let me know what version of TypeDoc you are using with any additional useful info so I can replicate the issue.

Many thanks.

from typedoc-plugin-markdown.

DrewLandgrave avatar DrewLandgrave commented on June 29, 2024

So I was using the [[foo]] notation described in the typedoc documentation becasue {@link} was not working... however I noticed that you were using foo notation. This doesn't autolink to the default theme or this one.

For reference I was doing the following Which links to the correct class in the default theme

 * @name AbstractMetadataModule
 * @description
 * Provides the module for the [[AbstractMetadataComponent]]
 * ```json
 * {
 *  declarations: [AbstractMetadataComponent],
 *  exports: [AbstractMetadataComponent],
 *  imports: [
 *    IonicModule,
 *    StackIonSelectModule,
 *  ],
 *  providers: [],
 * }
 * ```
 */```


Using the []()



```/**
 * @name AbstractMetadataModule
 * @description
 * Provides the module for the [AbstractMetadataComponent](./abstract_metadata_component.ts)
 * ```json
 * {
 *  declarations: [AbstractMetadataComponent],
 *  exports: [AbstractMetadataComponent],
 *  imports: [
 *    IonicModule,
 *    StackIonSelectModule,
 *  ],
 *  providers: [],
 * }
 * ```
 */``` 

And it's saying it can't find the file because for the default theme it's `abstractmetadatacomponent.html` 
and for this plugin it's `abstractmetadatamodule.md`

Could we support the [[]] notation that the default theme uses?

from typedoc-plugin-markdown.

tgreyuk avatar tgreyuk commented on June 29, 2024

Hi.. yes the link i sent you was generated using [[]] notation. Here is the source that is was generated from - https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/tests/src/doc-comments.ts#L9. I will see if I can replicate the issues you are having somehow. Just to confirm you are using latest version of the plugin?

from typedoc-plugin-markdown.

DrewLandgrave avatar DrewLandgrave commented on June 29, 2024

My package.json says "typedoc-plugin-markdown": "^1.0.7",

Here's the full file where the [[]] are not working.

Could it be because i'm getting the AbstractMetadataComponent from a barrell file?


import {AbstractMetadataComponent} from './index';
import {IonicModule} from 'ionic-angular';
import {StackIonSelectModule} from '../../../../../shared/components/stack_ion_select/stack_ion_select.component.module';

/**
 * @name AbstractMetadataModule
 * @description
 * Provides the module for the [[AbstractMetadataComponent]]
 * ```json
 * {
 *  declarations: [AbstractMetadataComponent],
 *  exports: [AbstractMetadataComponent],
 *  imports: [
 *    IonicModule,
 *    StackIonSelectModule,
 *  ],
 *  providers: [],
 * }
 * ```
 */
@NgModule({
  declarations: [AbstractMetadataComponent],
  exports: [AbstractMetadataComponent],
  imports: [
    IonicModule,
    StackIonSelectModule,
  ],
  providers: [],
})
export class AbstractMetadataModule {
}

EDIT:
Just tried changing the barrel to the file itself and it still didn't link correclty

from typedoc-plugin-markdown.

tgreyuk avatar tgreyuk commented on June 29, 2024

The issue was that the comments inside the @description tag were not being parsed properly.

The issue should now be fixed in new version (v1.0.8).

Many Thanks

from typedoc-plugin-markdown.

DrewLandgrave avatar DrewLandgrave commented on June 29, 2024

Can confirm! Thanks for the quick turnaround 💯

from typedoc-plugin-markdown.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.