Skip to content

Commit

Permalink
docs: remove useless front matter (#7518)
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh-Cena authored May 28, 2022
1 parent 432a8bd commit ab566ec
Show file tree
Hide file tree
Showing 58 changed files with 143 additions and 118 deletions.
1 change: 0 additions & 1 deletion website/docs/api/docusaurus.config.js.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
sidebar_position: 0
id: docusaurus.config.js
description: API reference for Docusaurus configuration file.
slug: /api/docusaurus-config
---
Expand Down
5 changes: 3 additions & 2 deletions website/docs/api/misc/create-docusaurus.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
sidebar_position: 0
title: '📦 create-docusaurus'
slug: '/api/misc/create-docusaurus'
slug: /api/misc/create-docusaurus
---

# 📦 create-docusaurus

A scaffolding utility to help you instantly set up a functional Docusaurus app.

## Usage {#usage}
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/misc/eslint-plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 1
id: eslint-plugin
title: '📦 eslint-plugin'
slug: '/api/misc/@docusaurus/eslint-plugin'
slug: /api/misc/@docusaurus/eslint-plugin
---

# 📦 eslint-plugin

[ESLint](https://eslint.org/) is a tool that statically analyzes your code and reports problems or suggests best practices through editor hints and command line. Docusaurus provides an ESLint plugin to enforce best Docusaurus practices.

## Installation
Expand Down
4 changes: 3 additions & 1 deletion website/docs/api/misc/eslint-plugin/no-untranslated-text.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
slug: '/api/misc/@docusaurus/eslint-plugin/no-untranslated-text'
slug: /api/misc/@docusaurus/eslint-plugin/no-untranslated-text
---

# no-untranslated-text

import APITable from '@site/src/components/APITable';

Enforce text labels in JSX to be wrapped by translate calls.

When the [i18n feature](../../../i18n/i18n-introduction.md) is used, this rule ensures that all labels appearing on the website are translatable, so no string accidentally slips through untranslated.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
slug: '/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages'
slug: /api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages
---

# string-literal-i18n-messages
Expand Down
5 changes: 3 additions & 2 deletions website/docs/api/misc/logger/logger.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
sidebar_position: 2
title: '📦 logger'
slug: '/api/misc/@docusaurus/logger'
slug: /api/misc/@docusaurus/logger
---

# 📦 logger

An encapsulated logger for semantically formatting console messages.

Authors of packages in the Docusaurus ecosystem are encouraged to use this package to provide unified log formats.
Expand Down
5 changes: 3 additions & 2 deletions website/docs/api/plugins/overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
sidebar_position: 0
id: plugins-overview
title: 'Docusaurus plugins'
sidebar_label: Plugins overview
slug: '/api/plugins'
slug: /api/plugins
---

# Docusaurus plugins

We provide official Docusaurus plugins.

## Content plugins {#content-plugins}
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-client-redirects.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 4
id: plugin-client-redirects
title: '📦 plugin-client-redirects'
slug: '/api/plugins/@docusaurus/plugin-client-redirects'
slug: /api/plugins/@docusaurus/plugin-client-redirects
---

# 📦 plugin-client-redirects

import APITable from '@site/src/components/APITable';

Docusaurus Plugin to generate **client-side redirects**.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-content-blog.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 2
id: plugin-content-blog
title: '📦 plugin-content-blog'
slug: '/api/plugins/@docusaurus/plugin-content-blog'
slug: /api/plugins/@docusaurus/plugin-content-blog
---

# 📦 plugin-content-blog

import APITable from '@site/src/components/APITable';

Provides the [Blog](blog.mdx) feature and is the default blog plugin for Docusaurus.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-content-docs.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 1
id: plugin-content-docs
title: '📦 plugin-content-docs'
slug: '/api/plugins/@docusaurus/plugin-content-docs'
slug: /api/plugins/@docusaurus/plugin-content-docs
---

# 📦 plugin-content-docs

import APITable from '@site/src/components/APITable';

Provides the [Docs](../../guides/docs/docs-introduction.md) functionality and is the default docs plugin for Docusaurus.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-content-pages.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 3
id: plugin-content-pages
title: '📦 plugin-content-pages'
slug: '/api/plugins/@docusaurus/plugin-content-pages'
slug: /api/plugins/@docusaurus/plugin-content-pages
---

# 📦 plugin-content-pages

import APITable from '@site/src/components/APITable';

The default pages plugin for Docusaurus. The classic template ships with this plugin with default configurations. This plugin provides [creating pages](guides/creating-pages.md) functionality.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-debug.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 5
id: plugin-debug
title: '📦 plugin-debug'
slug: '/api/plugins/@docusaurus/plugin-debug'
slug: /api/plugins/@docusaurus/plugin-debug
---

# 📦 plugin-debug

```mdx-code-block
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-google-analytics.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 6
id: plugin-google-analytics
title: '📦 plugin-google-analytics'
slug: '/api/plugins/@docusaurus/plugin-google-analytics'
slug: /api/plugins/@docusaurus/plugin-google-analytics
---

# 📦 plugin-google-analytics

import APITable from '@site/src/components/APITable';

The default [Google Analytics](https://developers.google.com/analytics/devguides/collection/analyticsjs/) plugin. It is a JavaScript library for measuring how users interact with your website **in the production build**. If you are using Google Analytics 4 you might need to consider using [plugin-google-gtag](./plugin-google-gtag.md) instead.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-google-gtag.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 7
id: plugin-google-gtag
title: '📦 plugin-google-gtag'
slug: '/api/plugins/@docusaurus/plugin-google-gtag'
slug: /api/plugins/@docusaurus/plugin-google-gtag
---

# 📦 plugin-google-gtag

import APITable from '@site/src/components/APITable';

The default [Global Site Tag (gtag.js)](https://developers.google.com/analytics/devguides/collection/gtagjs/) plugin. It is a JavaScript tagging framework and API that allows you to send event data to Google Analytics, Google Ads, and Google Marketing Platform. This section describes how to configure a Docusaurus site to enable global site tag for Google Analytics.
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-ideal-image.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 8
id: plugin-ideal-image
title: '📦 plugin-ideal-image'
slug: '/api/plugins/@docusaurus/plugin-ideal-image'
slug: /api/plugins/@docusaurus/plugin-ideal-image
---

# 📦 plugin-ideal-image

import APITable from '@site/src/components/APITable';

Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-pwa.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 9
id: plugin-pwa
title: '📦 plugin-pwa'
slug: '/api/plugins/@docusaurus/plugin-pwa'
slug: /api/plugins/@docusaurus/plugin-pwa
---

# 📦 plugin-pwa

Docusaurus Plugin to add PWA support using [Workbox](https://developers.google.com/web/tools/workbox). This plugin generates a [Service Worker](https://developers.google.com/web/fundamentals/primers/service-workers) in production build only, and allows you to create fully PWA-compliant documentation site with offline and installation support.

## Installation {#installation}
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/plugins/plugin-sitemap.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 10
id: plugin-sitemap
title: '📦 plugin-sitemap'
slug: '/api/plugins/@docusaurus/plugin-sitemap'
slug: /api/plugins/@docusaurus/plugin-sitemap
---

# 📦 plugin-sitemap

import APITable from '@site/src/components/APITable';

This plugin creates sitemaps for your site so that search engine crawlers can crawl your site more accurately.
Expand Down
5 changes: 3 additions & 2 deletions website/docs/api/themes/overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
sidebar_position: 0
id: themes-overview
title: 'Docusaurus themes'
sidebar_label: Themes overview
slug: '/api/themes'
slug: /api/themes
---

# Docusaurus themes

We provide official Docusaurus themes.

## Main themes {#main-themes}
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/themes/theme-classic.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 2
id: theme-classic
title: '📦 theme-classic'
slug: '/api/themes/@docusaurus/theme-classic'
slug: /api/themes/@docusaurus/theme-classic
---

# 📦 theme-classic

The classic theme for Docusaurus.

You can refer to the [theme configuration page](theme-configuration.md) for more details on the configuration.
Expand Down
8 changes: 4 additions & 4 deletions website/docs/api/themes/theme-configuration.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
sidebar_position: 1
id: theme-configuration
title: 'Theme configuration'
sidebar_label: 'Configuration'
slug: '/api/themes/configuration'
sidebar_label: Configuration
slug: /api/themes/configuration
toc_max_heading_level: 4
---

# Theme configuration

import APITable from '@site/src/components/APITable';

This configuration applies to all [main themes](./overview.md).
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/themes/theme-live-codeblock.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 3
id: theme-live-codeblock
title: '📦 theme-live-codeblock'
slug: '/api/themes/@docusaurus/theme-live-codeblock'
slug: /api/themes/@docusaurus/theme-live-codeblock
---

# 📦 theme-live-codeblock

This theme provides a `@theme/CodeBlock` component that is powered by react-live. You can read more on [interactive code editor](../../guides/markdown-features/markdown-features-code-blocks.mdx#interactive-code-editor) documentation.

```bash npm2yarn
Expand Down
6 changes: 3 additions & 3 deletions website/docs/api/themes/theme-search-algolia.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
sidebar_position: 4
id: theme-search-algolia
title: '📦 theme-search-algolia'
slug: '/api/themes/@docusaurus/theme-search-algolia'
slug: /api/themes/@docusaurus/theme-search-algolia
---

# 📦 theme-search-algolia

This theme provides a `@theme/SearchBar` component that integrates with Algolia DocSearch easily. Combined with `@docusaurus/theme-classic`, it provides a very easy search integration. You can read more on [search](../../search.md) documentation.

```bash npm2yarn
Expand Down
7 changes: 4 additions & 3 deletions website/docs/blog.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
id: blog
title: Blog
description: Deploy a full-featured blog in no time with Docusaurus.
---

# Blog

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The blog feature enables you to deploy in no time a full-featured blog.
The blog feature enables you to deploy a full-featured blog in no time.

:::info

Expand Down
5 changes: 3 additions & 2 deletions website/docs/browser-support.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
id: browser-support
title: Browser support
description: How to keep a reasonable bundle size while ensuring sufficient browser support.
---

# Browser support

Docusaurus allows sites to define the list of supported browsers through a [browserslist configuration](https://github.com/browserslist/browserslist).

## Purpose {#purpose}
Expand Down
2 changes: 1 addition & 1 deletion website/docs/cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: cli
description: Docusaurus provides a set of scripts to help you generate, serve, and deploy your website.
---

# CLI
Expand Down
5 changes: 3 additions & 2 deletions website/docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
id: configuration
title: Configuration
description: Configuring your site's behavior through docusaurus.config.js and more.
---

# Configuration

import TOCInline from '@theme/TOCInline';

Docusaurus has a unique take on configurations. We encourage you to congregate information about your site into one place. We guard the fields of this file and facilitate making this data object accessible across your site.
Expand Down
5 changes: 3 additions & 2 deletions website/docs/deployment.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
id: deployment
title: Deployment
description: Deploy your Docusaurus app for production on a range of static site hosting services.
---

# Deployment

To build the static files of your website for production, run:

```bash npm2yarn
Expand Down
4 changes: 2 additions & 2 deletions website/docs/docusaurus-core.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: docusaurus-core
title: Docusaurus Client API
sidebar_label: Client API
---

# Docusaurus Client API

Docusaurus provides some APIs on the clients that can be helpful to you when building your site.

## Components {#components}
Expand Down
4 changes: 2 additions & 2 deletions website/docs/guides/creating-pages.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
id: creating-pages
title: Creating Pages
slug: /creating-pages
sidebar_label: Pages
---

# Creating Pages

In this section, we will learn about creating pages in Docusaurus.

The `@docusaurus/plugin-content-pages` plugin empowers you to create **one-off standalone pages** like a showcase page, playground page, or support page. You can use React components, or Markdown.
Expand Down
3 changes: 2 additions & 1 deletion website/docs/guides/docs/docs-create-doc.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
id: create-doc
title: Create a doc
description: Create a Markdown Document
slug: /create-doc
---

# Create a doc

Create a Markdown file, `greeting.md`, and place it under the `docs` directory.

```bash
Expand Down
Loading

0 comments on commit ab566ec

Please sign in to comment.