diff --git a/configuration/project.md b/configuration/project.md index 62772331e..e56d300fd 100644 --- a/configuration/project.md +++ b/configuration/project.md @@ -167,7 +167,6 @@ branding: ``` === - --- ## breadcrumb @@ -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. diff --git a/guides/cli.md b/guides/cli.md index ec1bd090c..aab23c3e4 100644 --- a/guides/cli.md +++ b/guides/cli.md @@ -69,6 +69,7 @@ Arguments: Path to the project root or project config file [Optional] Options: + --pro Enable Retype Pro preview --secret Retype license key --password Private page password --host Custom Host name or IP address @@ -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). !!! diff --git a/pro/pro.md b/pro/pro.md index 3fd326973..c53526d63 100644 --- a/pro/pro.md +++ b/pro/pro.md @@ -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) @@ -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