这是indexloc提供的服务，不要输入任何密码
Skip to content

Add descriptions to MDX frontmatter #614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 11, 2022
Merged

Add descriptions to MDX frontmatter #614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
46768f9
Add description to MDX frontmatter
MaedahBatool Jan 26, 2022
19b68e0
Apply suggestions from code review
leerob Feb 1, 2022
e05239a
Merge branch 'main' into maedah-add-description
MaedahBatool Feb 10, 2022
62c1491
Merge branch 'main' into maedah-add-description
jaredpalmer Feb 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/pages/docs/acknowledgments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Acknowledgements and Prior Art
description: Thank you to all these developers, build systems, and monorepo tools for their support and assistance.
---

# Acknowledgements
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Changelog
description: Hear about new feature additions and changes to Turborepo.
---

This page is not used. It is just redirected to https://github.com/vercel/turborepo/releases
2 changes: 1 addition & 1 deletion docs/pages/docs/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Frequently Asked Questions
description: Frequently asked questions about Turborepo
description: Frequently asked questions about Turborepo.
---

# Frequently Asked Questions
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/features/caching.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Caching
description: Caching allows Turborepo to skip work that's already been done, for the fastest builds.
---

import Callout from "../../../components/callout";
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/features/pipelines.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Pipelines
description: Pipelines with Turborepo specify task relationships explicitly and conventionally.
---

import Callout from "../../../components/callout";
Expand Down
4 changes: 3 additions & 1 deletion docs/pages/docs/features/remote-caching.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Remote Caching
description: Share cache artifacts across machines for even faster builds.

---

import Callout from "../../../components/callout";
Expand All @@ -16,7 +18,7 @@ What if there was a way to teleport and share a single cache across machines? Al

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines for an additional speed boost. This is possible because Turborepo uses content addressable storage.

<Callout type="error">
<Callout type="error">
Remote Caching is a powerful feature of Turborepo, but with great power comes great responsibility. Make sure you are caching correctly first and double check handling of environment variables. Please also remember Turborepo treats logs as artifacts, so be aware of what you are printing to the console.
</Callout>

Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/features/scopes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Scoped tasks
description: Even faster Turborepo builds with scoped tasks.
---

import Callout from "../../../components/callout";
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Getting Started
description: Create your first monorepo or add Turborepo to an existing project.
---

import Callout from "../../components/callout";
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/glossary.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Glossary
description: A brief description of technical terms you might encounter while using Turborepo.
---

# Glossary
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/guides/complimentary-tools.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Awesome Monorepo Tools
description: Versioning, publishing, changelogs, linting, testing, automation, and more.
---

# Awesome Monorepo Tools
Expand Down
5 changes: 5 additions & 0 deletions docs/pages/docs/guides/migrate-from-lerna.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Migrate from Lerna
description: Learn how to incrementally adopt Turborepo from your existing Lerna monorepo.
---

# Using with Lerna

Turborepo and Lerna have a lot a in common, but also some key differences.
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Documentation
description: Turborepo is a high-performance build system for JavaScript and TypeScript codebases.
---

import Features from "../../components/features";
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/reference/codemods.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Turborepo Codemods
description: To make upgrading easier, Turborepo includes codemods and migration scripts.
---

# Turborepo Codemods
Expand Down
5 changes: 5 additions & 0 deletions docs/pages/docs/reference/command-line-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: CLI Reference
description: Turborepo is a high-performance build system for JavaScript and TypeScript codebases.
---

import Callout from '../../../components/callout'

# Command-Line Reference
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/reference/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Configuration Options
description: Learn how to configure Turborepo through `turbo.json`.
---

# Configuration Options
Expand Down
1 change: 1 addition & 0 deletions docs/pages/docs/upgrading-to-v1.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Upgrading to v1
description: Learn how to upgrade to Turborepo v1, now open-source and part of Vercel.
---

# Upgrading to Turborepo v1.x
Expand Down
1 change: 1 addition & 0 deletions docs/pages/privacy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Privacy Policy
description: Read the Privacy Policy for Turborepo.
hidden: true
headeronly: true
container: true
Expand Down
1 change: 1 addition & 0 deletions docs/pages/terms.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Terms of Service
description: Learn about the Terms of Service for Turborepo.
hidden: true
headeronly: true
container: true
Expand Down