Skip to content

Commit

Permalink
Add new --pro and start.pro: true features
Browse files Browse the repository at this point in the history
See #612
  • Loading branch information
geoffreymcgill committed Sep 16, 2023
1 parent 00f1786 commit f50d8c2
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 deletions.
18 changes: 17 additions & 1 deletion configuration/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,6 @@ branding:
```
===


---

## breadcrumb
Expand Down Expand Up @@ -1635,6 +1634,23 @@ Using the [CLI](../guides/cli.md#retype-start) command `retype start -n` or `ret

===

### pro

=== pro : `boolean`

The default is `false`.

The following sample demonstrates how to start your project in _Pro mode_ and trial the [Retype Pro](/pro/pro.md) features:

```yml
start:
pro: true
```

Using the [CLI](../guides/cli.md#retype-start) command `retype start --pro` will also start the project in Pro mode.

===

## templating

Configurations to control the Retype content templating engine for this project.
Expand Down
3 changes: 2 additions & 1 deletion guides/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ Arguments:
<path> Path to the project root or project config file [Optional]
Options:
--pro Enable Retype Pro preview
--secret <secret> Retype license key
--password <password> Private page password
--host <host> Custom Host name or IP address
Expand All @@ -82,7 +83,7 @@ Options:
!!!danger
While it is technically possible to host your website publicly using `retype start` and the web server built into Retype, **DON'T DO IT**.

You should use a dedicated website hosting service, such as [GitHub Pages](/hosting/github-pages.md), [Netlify](https://www.netlify.com/), or absolutely any other web hosting service.
You should use a dedicated website hosting service, such as [GitHub Pages](/hosting/github-pages.md), [Netlify](https://www.netlify.com/), [Cloudflare](/hosting/cloudflare.md), or absolutely any other web hosting service.

If you _really really really_ want to try public hosting using the built in web server, use [`retype serve`](#retype-serve).
!!!
Expand Down
14 changes: 14 additions & 0 deletions pro/pro.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Future Retype Pro only features | :icon-x-circle: | :white_check_mark: | :white_

## :icon-question: Questions & Answers

1. [Can I test Retype Pro features?](#can-i-test-retype-pro-features)
1. [Please summarize how the licensing works?](#please-summarize-how-the-licensing-works)
1. [If I do not renew, does my website stop working?](#if-i-do-not-renew-does-my-website-stop-working)
1. [Is Retype Pro a separate product?](#is-retype-pro-a-separate-product)
Expand All @@ -44,6 +45,19 @@ Future Retype Pro only features | :icon-x-circle: | :white_check_mark: | :white_
1. [We have other license requirements, are there other options?](#we-have-other-license-requirements-are-there-other-options)
1. [Contact us](#contact-us)

## Can I test Retype Pro features?

Yes. Use the command `retype start --pro` to start your project instead of `retype start`.

Or, add the following `pro: true` config to your project `retype.yml` file:

```yml
start:
pro: true
```
The [`poweredByRetype`](/configuration/project.md#poweredbyretype) branding will still be enabled and the 100 page limit will remain in place, but all other Retype Pro features will be available.

## Please summarize how the licensing works?

- [x] Retype is free to use for both commercial and open-source projects
Expand Down

0 comments on commit f50d8c2

Please sign in to comment.