@eagleoutice/flowr/documentation/doc-util/doc-files.d.ts

Static Dataflow Analyzer and Program Slicer for the R Programming Language

export declare const FlowrGithubGroupName = "flowr-analysis";
export declare const FlowrGithubBaseRef = "https://github.com/flowr-analysis";
export declare const FlowrSiteBaseRef = "https://flowr-analysis.github.io/flowr";
export declare const RemoteFlowrFilePathBaseRef = "https://github.com/flowr-analysis/flowr/tree/main/";
export declare const FlowrWikiBaseRef = "https://github.com/flowr-analysis/flowr/wiki";
export declare const FlowrGithubRef: string;
export declare const FlowrNpmRef = "https://www.npmjs.com/package/@eagleoutice/flowr";
export declare const FlowrDockerRef = "https://hub.docker.com/r/eagleoutice/flowr";
export declare const FlowrCodecovRef = "https://app.codecov.io/gh/flowr-analysis/flowr";
export declare const FlowrVsCode = "https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr";
export declare const FlowrPositron = "https://open-vsx.org/extension/code-inspect/vscode-flowr";
export declare const FlowrRStudioAddin = "https://github.com/flowr-analysis/rstudio-addin-flowr";
export declare const FlowrRAdapter = "https://github.com/flowr-analysis/flowr-r-adapter";
/**
 * Returns a markdown link to the given file path relative to the project root.
 */
export declare function getFilePathMd(path: string): string;
/**
 * Returns the content of a file located at the given path relative to the project root.
 * This reads the file synchronously from disk.
 */
export declare function getFileContentFromRoot(path: string): string;
/**
 * Returns a markdown link to the given flowr source file path.
 */
export declare function linkFlowRSourceFile(path: string): string;