Skip to content

Commit

Permalink
Merge branch 'release/1.2.9'
Browse files Browse the repository at this point in the history
  • Loading branch information
DominusKelvin committed Apr 17, 2024
2 parents de369ee + 8e5e12f commit 8ef3793
Show file tree
Hide file tree
Showing 30 changed files with 2,275 additions and 197 deletions.
5 changes: 5 additions & 0 deletions docs/.vitepress/config.js → docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { OramaPlugin } from '@orama/plugin-vitepress'

export default {
lang: 'en-US',
title: 'Sailscasts Docs',
Expand Down Expand Up @@ -75,6 +77,9 @@ export default {
apiKey: '6c5e9ae85dc5c0672b6df0b2e305f6cb',
indexName: 'sailscasts'
}
},
vite: {
plugins: [OramaPlugin()]
}
}

Expand Down
2 changes: 1 addition & 1 deletion docs/boring-stack/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ next:
editLink: true
---

# {{ $frontmatter.title }} {#authentication}
# Authentication {#authentication}

Authentication is the process of verifying the identity of a user, typically through credentials like a username and password. For example, logging into a GitHub account requires authentication.

Expand Down
2 changes: 1 addition & 1 deletion docs/boring-stack/redirects.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ next:
editLink: true
---

# {{ $frontmatter.title }} {#redirects}
# Redirects {#redirects}

## Route target redirect

Expand Down
2 changes: 1 addition & 1 deletion docs/captain-vane/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Use captain-vane to generate test data
editLink: true
---

# {{ $frontmatter.title }}
# Basic Usage

Basic usage of captain-vane is to generate a factory file and use the ` vane`` helper provided by `captain-vane`` to create records using the generated factory and model definition.

Expand Down
2 changes: 1 addition & 1 deletion docs/captain-vane/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: To install and setup captain-vane run npm i --save-dev captain-vane
editLink: true
---

# {{ $frontmatter.title }}
# Installation

Add captain-vane and captain-vane-generator development dependencies to your project.
Add `captain-vane` and `captain-vane-generator` development dependencies to your project:
Expand Down
2 changes: 1 addition & 1 deletion docs/captain-vane/what-is-captain-vane.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: What is captain-vane?
editLink: true
---

# {{ $frontmatter.title }}
# What is captain-vane?

captain-vane is a Sails hook that allows you generate realistically test data for a Sails application.

Expand Down
2 changes: 1 addition & 1 deletion docs/create-sails/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Basic Usage
editLink: true
---

# {{ $frontmatter.title }}
# Basic Usage

```sh
npx create-sails <project-name>
Expand Down
2 changes: 1 addition & 1 deletion docs/create-sails/what-is-create-sails.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: What is create-sails?
editLink: true
---

# {{ $frontmatter.title }}
# What is create-sails?

An easy way to start a modern full-stack Sails project.

Expand Down
2 changes: 1 addition & 1 deletion docs/guppy/activating-guppy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Activating guppy
editLink: true
---

# {{ $frontmatter.title }}
# Activating guppy

After you've [purchased](https://guppy.sailscasts.com/#buy) a guppy license, downloaded and install guppy on your machine, on the first run of guppy you will be presented with the below screen 👇🏾

Expand Down
2 changes: 1 addition & 1 deletion docs/guppy/deactivating-guppy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Deactivating guppy
editLink: true
---

# {{ $frontmatter.title }}
# Deactivating guppy

If you have a valid guppy license and you have activated guppy on 2 computers already and you want to use the app on another computer, you first have to deactivate guppy on one of those computers it is currently running on.

Expand Down
2 changes: 1 addition & 1 deletion docs/guppy/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Installation
editLink: true
---

# {{ $frontmatter.title }}
# Installation

Once you [purchase](https://guppy.sailscasts.com/#buy) a guppy license, you will receive an email containing the following:

Expand Down
2 changes: 1 addition & 1 deletion docs/guppy/running-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Running code
editLink: true
---

# {{ $frontmatter.title }}
# Running code

guppy can evaluate your Javascript code in one of two ways:

Expand Down
2 changes: 1 addition & 1 deletion docs/guppy/what-is-guppy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: What is guppy?
editLink: true
---

# {{ $frontmatter.title }}
# What is guppy?

![guppy](/images/guppy/preview.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/inertia-sails/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Basic Usage
editLink: true
---

# {{ $frontmatter.title }}
# Basic Usage

## Responses

Expand Down
2 changes: 1 addition & 1 deletion docs/inertia-sails/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Installation
editLink: true
---

# {{ $frontmatter.title }}
# Installation

## Backend

Expand Down
2 changes: 1 addition & 1 deletion docs/inertia-sails/what-is-inertia-sails.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: What is inertia-sails?
editLink: true
---

# {{ $frontmatter.title }}
# What is inertia-sails?

inertia-sails is the Sails adapter for Inertia.

Expand Down
2 changes: 1 addition & 1 deletion docs/mail/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ next:
link: '/mail/smtp-transport'
---

# {{ $frontmatter.title }}
# Configuration

To configure mail, create a `config/mail.js` configuration file. Let's look at all the possible configurations you can have in `config/mail.js`

Expand Down
2 changes: 1 addition & 1 deletion docs/mail/email-layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ next:
link: '/mail/send-helper'
---

# {{ $frontmatter.title }}
# Email Layout

You can create layouts for the emails in your Sails application. This layout file, like [templates](/mail/email-template) is expected to be an EJS template.

Expand Down
2 changes: 1 addition & 1 deletion docs/mail/email-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ next:
link: '/mail/email-layout'
---

# {{ $frontmatter.title }}
# Email Template

Mail expects your email templates to be written in EJS template files or whatever template engine you've setup in your Sails project. These files are expected to be in the `views/emails` directory.

Expand Down
2 changes: 1 addition & 1 deletion docs/mail/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ next:
link: '/mail/configuration'
---

# {{ $frontmatter.title }}
# Getting started

## Introduction

Expand Down
2 changes: 1 addition & 1 deletion docs/mail/local-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ prev:
link: '/mail/resend-transport'
---

# {{ $frontmatter.title }}
# Local development

When creating an application that involves sending emails, you likely wouldn't want to send actual emails to active email addresses during local development.

Expand Down
2 changes: 1 addition & 1 deletion docs/mail/resend-transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ next:
link: '/mail/local-development'
---

# {{ $frontmatter.title }}
# Resend Transport

To use the [Resend](https://resend.com) transport, install `resend` via NPM:

Expand Down
2 changes: 1 addition & 1 deletion docs/mail/send-helper.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ prev:
next: false
---

# {{ $frontmatter.title }}
# Send Helper

Mail provides a `send` helper that is used to send your emails within your Sails applications. The `send` helper takes in several optional and required arguments like `mailer`, `template`, `templateData` etc.

Expand Down
2 changes: 1 addition & 1 deletion docs/mail/smtp-transport.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ next:
link: '/mail/resend-transport'
---

# {{ $frontmatter.title }}
# SMTP Transport

To use the SMTP transport, which is a protocol several email services supports, install `nodemailer` via NPM:

Expand Down
2 changes: 1 addition & 1 deletion docs/wish/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: GitHub OAuth
editLink: true
---

# {{ $frontmatter.title }}
# GitHub OAuth

To setup up a GitHub OAuth for your app, Wish expects the following key and property in either `config/local.js` or `config/custom.js`. For example you can have a development GitHub clientId and clientSecret in `config/local.js`

Expand Down
2 changes: 1 addition & 1 deletion docs/wish/google.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Google OAuth
editLink: true
---

# {{ $frontmatter.title }}
# Google OAuth

To setup up a Google OAuth for your app, Wish expects the following key and property in either `config/local.js` or `config/custom.js`.

Expand Down
2 changes: 1 addition & 1 deletion docs/wish/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Installation
editLink: true
---

# {{ $frontmatter.title }}
# Intallation

In your Sails project run the below command to install wish and it's node-fetch peer-dependency:

Expand Down
2 changes: 1 addition & 1 deletion docs/wish/what-is-wish.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: What is Wish?
editLink: true
---

# {{ $frontmatter.title }}
# What is Wish?

Wish is the [OAuth](https://en.wikipedia.org/wiki/OAuth) Sails hook you wish(pun intended) exists for Sails.

Expand Down
Loading

0 comments on commit 8ef3793

Please sign in to comment.