mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
2d8635d29d
To increase the ease of development we are moving @angular/docs into the adev directory within this repo. While we are doing this to improve our development experience in the short term, efforts are also in place to maintain a division between this @angular/docs (shared) code and adev itself, so that it can be extracted back out in the future when components is ready to leverage it as well. PR Close #57132
50 lines
1.6 KiB
TypeScript
50 lines
1.6 KiB
TypeScript
/*!
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.dev/license
|
|
*/
|
|
|
|
import {existsSync, readFileSync} from 'fs';
|
|
import {join} from 'path';
|
|
import {cwd} from 'process';
|
|
|
|
// TODO(josephperrott): Set edit content url based on the owner, repo and branch.
|
|
|
|
/** The base url for edting the a file in the repository. */
|
|
const GITHUB_EDIT_CONTENT_URL = 'https://github.com/angular/angular/edit/main';
|
|
|
|
/** Get the page title with edit button to modify the page source. */
|
|
export function getPageTitle(text: string): string {
|
|
return `
|
|
<!-- Page title -->
|
|
<div class="docs-page-title">
|
|
<h1 tabindex="-1">${text}</h1>
|
|
<a class="docs-github-links" target="_blank" href="${GITHUB_EDIT_CONTENT_URL}/${context?.markdownFilePath}" title="Edit this page" aria-label="Edit this page">
|
|
<!-- Pencil -->
|
|
<docs-icon role="presentation">edit</docs-icon>
|
|
</a>
|
|
</div>`;
|
|
}
|
|
|
|
/** Configuration using environment for parser, providing context. */
|
|
export interface ParserContext {
|
|
markdownFilePath?: string;
|
|
}
|
|
|
|
let context: ParserContext = {};
|
|
export function setContext(envContext: Partial<ParserContext>) {
|
|
context = envContext;
|
|
}
|
|
|
|
/** The base directory of the workspace the script is running in. */
|
|
const WORKSPACE_DIR = cwd();
|
|
|
|
export function loadWorkspaceRelativeFile(filePath: string): string {
|
|
const fullFilePath = join(WORKSPACE_DIR, filePath);
|
|
if (!existsSync(fullFilePath)) {
|
|
throw Error(`Cannot find: ${filePath}`);
|
|
}
|
|
return readFileSync(fullFilePath, {encoding: 'utf-8'});
|
|
}
|