Skip to content

Commit

Permalink
-
Browse files Browse the repository at this point in the history
  • Loading branch information
Ehesp committed Jul 16, 2024
1 parent 4eb426c commit b70b177
Show file tree
Hide file tree
Showing 22 changed files with 7 additions and 55 deletions.
2 changes: 0 additions & 2 deletions docs/components/callouts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Callouts
description: Add callout boxes to your pages to display important information.
---

# Callouts

Callouts help break up the page flow by providing colorful boxes with text information to notifiy the user about something important on the page.

## Info Callout
Expand Down
2 changes: 0 additions & 2 deletions docs/components/code-blocks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Code Blocks
description: Display code blocks with syntax highlighting.
---

# Code Blocks

Render code blocks inline or as a code snippet with syntax highlighting by enclosing them in backticks (`).

## Inline Code
Expand Down
2 changes: 0 additions & 2 deletions docs/components/custom.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Custom Components
description: Use page level custom components in your documentation
---

# Custom Components

Those familar with [MDX](https://mdxjs.com/) may be familiar with the concept of custom components.
With MDX, you can create your own components and use them in your markdown files.

Expand Down
2 changes: 0 additions & 2 deletions docs/components/headings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Headings
description: Use headings in your documentation
---

# Headings

All markdown headings will be rendered in a size ordered format. You can render headings using the `#` symbol,
with the number of hashes indicating the heading type.

Expand Down
2 changes: 0 additions & 2 deletions docs/components/images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Images
description: Add images to your documentation
---

# Images

Images can be displayed from remote, or local sources using either standard Markdown syntax,
or the `<Image>` component.

Expand Down
4 changes: 1 addition & 3 deletions docs/components/tabs.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Display content within different tabs
title: Tabs
description: Learn how to display content within different tabs
---

# Tabs

Tabs are a great way to display content within different tabs. Tabs can be displayed using the `<Tabs>` component,
providing a label and value.

Expand Down
6 changes: 2 additions & 4 deletions docs/components/tweet.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Embed Tweets
title: Tweets
description: Embed Tweets in your documentation.
---

# Tweets

To imbed a tweet into the documentation, use the `<Tweet>` component and provide the ID of the tweet.
To embed a tweet into the documentation, use the `<Tweet>` component and provide the ID of the tweet.

```jsx
<Tweet id="1513662173796605958" />
Expand Down
4 changes: 1 addition & 3 deletions docs/components/video.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Add videos to your documentation
title: Videos
description: Learn how to add videos to your documentation.
---

# Video

A general purpose video component, extends the HTML `<video>` element.

## Usage
Expand Down
4 changes: 1 addition & 3 deletions docs/components/vimeo.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Add Vimeo videos to your documentation
title: Vimeo
description: Learn how to add Vimeo embeds to your documentation.
---

# Vimeo

[Vimeo](https://vimeo.com/) is a service for hosting videos.

## Embedding
Expand Down
2 changes: 0 additions & 2 deletions docs/components/youtube.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Add YouTube videos to your documentation
description: Learn how to add YouTube embeds to your documentation.
---

# YouTube

[YouTube](https://youtube.com/) is a service for hosting videos.

## Embedding
Expand Down
4 changes: 1 addition & 3 deletions docs/components/zapp.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Add Zapp! embeds to your documentation
title: Zapp!
description: Learn how to add Zapp! embeds to your documentation.
---

# Zapp!

[Zapp!](https://zapp.run) is a free online Dart & Flutter sandbox that lets you run Dart code in the browser. It's great for sharing code snippets in your documentation.

## Embedding Zapp!
Expand Down
2 changes: 0 additions & 2 deletions docs/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Configuration
description: Configure your documentation with a docs.json file.
---

# Configuration

You can heavily customize your documentation by providing a configuration file at the root of your
GitHub repository. The configuration file syntax supports JSON or YAML.

Expand Down
4 changes: 0 additions & 4 deletions docs/contributing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ title: Contributing
description: Learn how to run docs.page locally and help contribute to the project.
---

# Contributing

Learn how to run docs.page locally and help contribute to the project.

## Running locally

Firstly, fork the [https://github.com/invertase/docs.page](https://github.com/invertase/docs.page) repository.
Expand Down
2 changes: 0 additions & 2 deletions docs/custom-domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Custom Domains
description: Learn how to set up a custom domain for your project.
---

# Custom Domains

Custom domain support with `docs.page` allows you to serve your documentation content through any domain (or subdomain)
you own rather than via the `https://docs.page` domain.

Expand Down
4 changes: 0 additions & 4 deletions docs/en.mdx

This file was deleted.

4 changes: 1 addition & 3 deletions docs/frontmatter.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Frontmatter
description: Learn about the options available via page Frontmatter.
description: Learn about configuring your documentation pages with frontmatter.
---

# Frontmatter

Frontmatter is a way to customize metadata of a page directly within your Markdown files. The metadata properties can
be added to Markdown pages by adding frontmatter blocks to the top of any page.

Expand Down
2 changes: 0 additions & 2 deletions docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Getting Started
description: Get started with docs.page on your repository.
---

# Getting Started

The docs.page project reads files directly from your GitHub repository. To get started:

1. Create a `docs` directory to any **public** GitHub repository.
Expand Down
2 changes: 0 additions & 2 deletions docs/github-bot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: GitHub Bot
description: Install our GitHub bot on repositories using docs.page
---

# GitHub Bot

When pull requests are made to your repository, being able to visually view how changes within the pull request
impact your documentation is extremely valuable. The docs.page GitHub bot comments on new pull requests
with a dedicated URL allowing anyone to view the documentation for the specific pull request.
Expand Down
2 changes: 0 additions & 2 deletions docs/locales.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Locales
description: Add locale support to your documentation
---

# Locales

Locale support is achived configuring the `sidebar` in your [configuration file](/configuration).

When locale support is enabled, a language switcher will appear in the sidebar.
Expand Down
2 changes: 0 additions & 2 deletions docs/previews.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Previews
description: Learn how to preview your documentation.
---

# Previews

docs.page allows you to preview any repository reference, such as a branch, pull request or specific commit.

> Use the [GitHub bot](/github-bot) to automatically comment on pull requests with the preview URL!
Expand Down
2 changes: 0 additions & 2 deletions docs/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Search
description: Add powerful documentation search using DocSearch
---

# Search

docs.page uses [DocSearch](https://docsearch.algolia.com/) by Algolia to provide full, in-depth rich search
to your documentation for free.

Expand Down
2 changes: 0 additions & 2 deletions docs/writing-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Writing Content
description: Learn about how to write Markdown content for your site.
---

# Writing Content

docs.page supports writing Markdown in the [GFM](https://github.github.com/gfm/) (GitHub Flavored Markdown) format. This means you can write your
content in a familiar format and it will be rendered as HTML.

Expand Down

0 comments on commit b70b177

Please sign in to comment.