tsconfig alias-support-documentation (PR from TinaCMS) #2647
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![tina-cloud-app[bot]](https://avatars.githubusercontent.com/in/47631?s=60&v=4){kind=small}
Co-authored-by: Ben Neoh <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
ncn-ssw
reviewed
Dec 24, 2024
| @@ -55,4 +55,39 @@ export default defineConfig({ | |||
| ``` | |||
|
|
|||
| In this example, the TinaCMS admin will be viewable at `<my-site-url>/admin/index.html`. | |||
| For more information [check out the content modeling section](/docs/schema/). | |||
| For more information [check out the content modeling section](/docs/schema/).\ | |||
| \ | |||
There was a problem hiding this comment.
question: Why are the backslashes required?
ncn-ssw
reviewed
Dec 24, 2024
|
|
||
| ## Typescript Path Alias | ||
|
|
||
| TinaCMS supports typeScript path aliases in the tina.config.js file and collections, making it easier to organize and maintain your code. |
There was a problem hiding this comment.
typo:
Suggested change
| TinaCMS supports typeScript path aliases in the tina.config.js file and collections, making it easier to organize and maintain your code. | |
| TinaCMS supports TypeScript path aliases in the `tina.config.js` file and collections, making it easier to organize and maintain your code. |
ncn-ssw
reviewed
Dec 24, 2024
|
|
||
| ##### Use alias in config.ts | ||
|
|
||
| Ensure that tsconfig.json exists at the root of your project. Define your aliases in the compilerOptions section: |
There was a problem hiding this comment.
consistency: The introductory paragraph has the files and in-code declaration formatted as in-line code.
Suggested change
| Ensure that tsconfig.json exists at the root of your project. Define your aliases in the compilerOptions section: | |
| Ensure that `tsconfig.json` exists at the root of your project. Define your aliases in the `compilerOptions` section: |
ncn-ssw
reviewed
Dec 24, 2024
| } | ||
| ``` | ||
|
|
||
| Figure: Your defined tsconfig.json |
There was a problem hiding this comment.
consistency: As described above:
Suggested change
| Figure: Your defined tsconfig.json | |
| Figure: Your defined `tsconfig.json` |
ncn-ssw
reviewed
Dec 24, 2024
| }) | ||
| ``` | ||
|
|
||
| Figure: Using aliases in tina config.ts |
There was a problem hiding this comment.
consistency: As described above:
Suggested change
| Figure: Using aliases in tina config.ts | |
| Figure: Using aliases in tina `config.ts` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This documentation pr is related to new support feature
PR in tinacms
Related issue