Star

MIT License
Copyright © 2020
CONNECT-platform

linkCode References

If a line in a code-snippet contains a comment has the syntax // @see somelink, then when the line is hovered a clickable link to link will be displayed:

1```cpp

2void func() { // @see http://www.cplusplus.com/doc/tutorial/functions/

3}

4```

1```js

2function func() { /* @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Functions */

3}

4```

1```python

2def func(): #@see https://www.learnpython.org/en/Functions

3 pass

4```

1```html

2<div hidden></div> <!-- @see https://www.w3schools.com/tags/att_global_hidden.asp -->

3```

1void func() { // @see http://www.cplusplus.com/doc/tutorial/functions/

2}

1function func() { /* @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Functions */

2}

1def func(): #@see https://www.learnpython.org/en/Functions

2 pass

1<div hidden></div> <!-- @see https://www.w3schools.com/tags/att_global_hidden.asp -->


You can also use markdown link syntax [title](link) for giving your references meaningful titles:

1```cpp

2void func() { // @see [the docs](http://www.cplusplus.com/doc/tutorial/functions/)

3}

4```

1void func() { // @see [the docs](http://www.cplusplus.com/doc/tutorial/functions/)

2}


warning WARNING

Only the simple [title](link) syntax is supported. So the following would not work:


linkTab References

If you have a code snippet inside a Tabs component, you can also use references to reference other tabs, with using tab:<tab-title> (or tab:<tab-id> for when you have specified a tab ID) format for your link:

1> :Tabs

2> > :Tab title=Main Thing

3> > ```ts

4> > import { Stuff } from './other-thing'; // @see tab:Other Thing

5> > import { MoreStuff } from './other-thing'; // @see [le source](tab:Other Thing)

6> > ```

7>

8> > :Tab title=Other Thing

9> > ```ts

10> > export const Stuff = 2;

11> > export const MoreStuff = 3; // --> bet you expected more from this code sample didn't ya?

12> > ```

1import { Stuff } from './other-thing'; // @see tab:Other Thing

2import { MoreStuff } from './other-thing'; // @see [le source](tab:Other Thing)

1export const Stuff = 2;

2export const MoreStuff = 3; // --> bet you expected more from this code sample didn't ya?


linkSupported Languages

This feature is currently only supported in languages where one of the following comment syntaxes is valid:

1// single-line comment

1/* multi line comment */

1# comment starting with a hash

1<!-- HTML style comment -->

Code ReferencesLink TitlesTab ReferencesSupported Languages

Home Overview CLI Theme

Markdownchevron_right
Code Featureschevron_right

Images & Assets

Configurationchevron_right
Customizationchevron_right