Skip to content

Latest commit

 

History

History
215 lines (151 loc) · 6.49 KB

cli.md

File metadata and controls

215 lines (151 loc) · 6.49 KB
Raw
order icon
-100
terminal

Retype CLI

The Retype CLI is clean and simple. The majority of the time you will run just one command: retype watch

!!!

Be sure to review the project options available within the retype.json as it does unlock a lot more power, flexibility, and customization.

!!!

The --help option can be passed with any command to get additional details, for instance retype watch --help will return all options for the retype watch command.

Let's go through each of the retype CLI commands, or be sure to check out the Getting Started guide for step by instructions on using each of these commands.

retype watch

The retype watch command is the easiest way to get your project built and running in a browser within seconds, although retype watch is just shortcut for a sequence of other commands that could be executed individually.

retype init
retype build
retype run

The retype watch command will also watch for file changes and will automatically update the website in your web browser with the updated page.

Options

watch:
  Serve a static website, watch for file changes

Usage:
  retype watch [options] [<path>]

Arguments:
  <path>    Path to the project root or retype.json [Optional]

Options:
  -a, --api              Watch for API changes
  --license <license>    Retype license key
  --port <port>          Custom TCP port
  -v, --verbose          Verbose logging
  -?, -h, --help         Show help and usage information

retype init

You can manually create a retype.json file, or you can have Retype stub out a basic file with a few initial values by running the command retype init.

From your command line, navigate to any folder location where you have one or more Markdown .md files, such as the root of a GitHub project, then run the following command:

retype init

Calling the retype init command will create a simple retype.json file with the following default values:

{
  "input": ".",
  "output": ".retype",

  "branding": {
    "title": "Project Name",
    "label": "Docs"
  },

  "links": [
    {
      "text": "Getting Started",
      "link": "https://retype.com/getting-started/"
    }
  ],

  "footer": {
    "copyright": "© Copyright {{ year }}. All rights reserved."
  }
}

All the configs are optional, but the above sample demonstrates a few of the options you will typically want to start with. See the project configuration docs for a full list of all options.

To change the title of the project, revise the branding.title config. For instance, let's change to "Company X":

{
  "branding": {
    "title": "Company X",
  }
}

If there is already a retype.json file within the project, runnin the retype init command will not create a new retype.json file.

The retype.json file is not actually required, but you will want to make custom configurations to your project and this is how those instructions are passed to Retype.

Options

init:
  Initialize a new Retype project

Usage:
  retype init [options] [<path>]

Arguments:
  <path>    Path to the project root [Optional]

Options:
  --override <override>    JSON configuration overriding retype.json values
  -v, --verbose            Verbose logging
  -?, -h, --help           Show help and usage information

retype build

To generate your new website, run the command retype build. This command builds a new website based upon the .md files within the input location.

retype build

Within just a few seconds, Retype will create a new website and save to the output location as defined in the retype.json. By default, the output location is a new folder named retype. You can rename to whatever you like, or adjust the path to generate the output to any other location, such as another sub-folder.

If the .md documentation files for your project were located not in the root (.) but within a docs subfolder AND you wanted to have Retype send the output to a website folder, you would use the following config:

{
  "input": "docs",
  "output": "website",
}

Let's say you wanted the your new Retype website to run from within a docs folder which was then also inside of a root website folder, then you would configure:

{
  "input": "docs",
  "output": "website/docs"
}

If you are hosting your website using GitHub Pages AND you wanted to host your website from the docs folder, you could then move your .md files into a different subfolder and configure as follows:

{
  "input": "src",
  "output": "docs"
}

The input and output configs provide unlimited flexibility to instruct Retype on where to get your project content and configurations files and where to output the generated website.

Options

build:
  Generate a static website

Usage:
  retype build [options] [<path>]

Arguments:
  <path>    Path to the project root or retype.json [Optional]

Options:
  --output <output>        Custom path to the output directory
  --license <license>      Retype license key
  --override <override>    JSON configuration overriding retype.json values
  -v, --verbose            Verbose logging
  -?, -h, --help           Show help and usage information

retype run

The retype run command starts up your new Retype website and opens in a web browser.

retype run

The website generated by Retype is a static HTML and JavaScript site. No special server-side hosting, such as PHP or Ruby is required. A Retype generated website can be hosted on any webserver or hosting service, such a GitHub Pages.

You can also use any other local web server instead of retype run. Retype only includes a web server out of convenience, not requirement. Any web server will do. A couple other simple options could be live-server or static-server.

Options

run:
  Serve a static website

Usage:
  retype run [options] [<path>]

Arguments:
  <path>    Path to the project root or retype.json [Optional]

Options:
  --port <port>     Custom TCP port
  -v, --verbose     Verbose logging
  -?, -h, --help    Show help and usage information