Skip to content

custompages.md

Latest commit

 

History

History
59 lines (37 loc) · 2.17 KB

custompages.md

File metadata and controls

59 lines (37 loc) · 2.17 KB

rdme custompages

Upload Markdown or HTML files to the Custom Pages section of your ReadMe project.

rdme custompages upload PATH

Upload Markdown or HTML files to the Custom Pages section of your ReadMe project.

USAGE
  $ rdme custompages upload PATH --key <value> [--branch <value>] [--dry-run]

ARGUMENTS
  PATH  Path to a local Markdown/HTML file or folder of Markdown/HTML files.

FLAGS
  --key=<value>     (required) ReadMe project API key
  --branch=<value>  [default: stable] ReadMe project version
  --dry-run         Runs the command without creating nor updating any custom pages in ReadMe. Useful for debugging.

DESCRIPTION
  Upload Markdown or HTML files to the Custom Pages section of your ReadMe project.

  The path can either be a directory or a single Markdown/HTML file.

  The Markdown/HTML files will require YAML frontmatter with certain ReadMe documentation attributes. Check out our docs
  for more info on setting up your frontmatter: https://docs.readme.com/main/docs/rdme#markdown-file-setup

EXAMPLES
  The path input can be a directory. This will also upload any Markdown/HTML files that are located in subdirectories:

    $ rdme custompages upload documentation/ --branch={project-branch}

  The path input can also be individual Markdown/HTML files:

    $ rdme custompages upload documentation/about.md --branch={project-branch}

  You can omit the `--branch` flag to default to the `stable` branch of your project:

    $ rdme custompages upload [path]

  This command also has a dry run mode, which can be useful for initial setup and debugging. You can read more about
  dry run mode in our docs: https://docs.readme.com/main/docs/rdme#dry-run-mode

    $ rdme custompages upload [path] --dry-run

FLAG DESCRIPTIONS
  --key=<value>  ReadMe project API key

    An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
    usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v10#authentication

  --branch=<value>  ReadMe project version

    Defaults to `stable` (i.e., your main project version).