Skip to content

Support links and wikilinks in code comments #1506

@dukeofgaming

Description

@dukeofgaming

Is your feature request related to a problem? Please describe.

Using Docs as Code as a documentation approach can be very useful and engaging.

It would be nice if Foam would parse wikilinks within attachments.

Describe the solution you'd like

It may be tricky to parse [[...]] if one specifies code files as attachments, since double square braces may be code syntax.

However, comments across languages are fairly consistent, usually only being:

  • #, // and -- (YAML, SQL) for single line comments
  • /* ...*/, """...""", '''...''', <!-- ... ---> for stream comments

If a link or wikilinks are found within comments within attachments (I don't think anyone would want to specify code files as notes), it should be processed as such.

Describe alternatives you've considered

Regular bare file links, however, these won't show in the graph nor allow easy navigation between notes.

Screenshots or Videos

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions