Comments (6)
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.
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.
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.
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.
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.
Can confirm! Thanks for the quick turnaround 💯
from typedoc-plugin-markdown.
Related Issues (20)
- [docusaurus-plugin-typedoc] `outputFileStrategy` option from `typedoc-plugin-markdown` HOT 4
- enhance examples in a type declaration block HOT 2
- Adding support for typedoc-plugin-coverage HOT 8
- markdown generated using triple quote making it icompatible with current docusaurus system HOT 3
- Getting extra spaces before a function parameter HOT 3
- Duplication in callback/callable/function properties. HOT 2
- `TypeDoc exited with an error` but got exit code 0 HOT 1
- --entryDocument Argument Is Ignored By typedoc-github-wiki-theme HOT 2
- Superfluous newlines in table column descriptions HOT 6
- [email protected]: TypeError: Cannot read properties of undefined HOT 1
- 4.0.0-next.58: These sidebar document ids do not exist HOT 1
- A class file is generated twice HOT 13
- Sidebar item's id not exist HOT 2
- bug: (v4) markdown html `style` tags do not get converted to JSX compliant style tags HOT 2
- Could not write when excludeScopesInPaths true. HOT 1
- Generates Filenames with special chars HOT 5
- `sanitizeComments` doesn't add escape characters in front of `<` characters in JSDoc comments HOT 2
- Links to MDN are broken with `typedoc-plugin-mdn-links` since version `4.0.0` HOT 1
- Single newlines in @param blocks are interpreted as linebreaks in generated markdown HOT 3
- Invalid Invalid Link with `outputFileStrategy: 'modules'` and `flattenOutputFiles: true` HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from typedoc-plugin-markdown.