Skip to content

Commit c0a44cf

Browse files
authored
docs: whoops bring this doc back, but with a callout (#1215)
i've changed my mind lol, it'll still be good to have this doc for support purposes! but i made a few tweaks so the risk is clearly conveyed to folks
1 parent e6be705 commit c0a44cf

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

documentation/commands/docs.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
`rdme docs`
2+
===========
3+
4+
Upload Markdown files to the Guides section of your ReadMe project.
5+
6+
* [`rdme docs upload PATH`](#rdme-docs-upload-path)
7+
8+
## `rdme docs upload PATH`
9+
10+
> [!WARNING]
11+
> This command is in an experimental alpha and is likely to change. Use at your own risk!
12+
13+
<details>
14+
15+
16+
<summary>I understand the risks — let's see the docs!</summary>
17+
18+
Upload Markdown files to the Guides section of your ReadMe project.
19+
20+
```
21+
USAGE
22+
$ rdme docs upload PATH --key <value> [--github] [--dry-run] [--version <value>]
23+
24+
ARGUMENTS
25+
PATH Path to a local Markdown file or folder of Markdown files.
26+
27+
FLAGS
28+
--dry-run Runs the command without creating nor updating any Guides in ReadMe. Useful for debugging.
29+
--github Create a new GitHub Actions workflow for this command.
30+
--key=<value> (required) ReadMe project API key
31+
--version=<value> [default: stable] ReadMe project version
32+
33+
DESCRIPTION
34+
Upload Markdown files to the Guides section of your ReadMe project.
35+
36+
The path can either be a directory or a single Markdown file. The Markdown files will require YAML frontmatter with
37+
certain ReadMe documentation attributes. Check out our docs for more info on setting up your frontmatter:
38+
https://docs.readme.com/main/docs/rdme#markdown-file-setup
39+
40+
EXAMPLES
41+
The path input can be a directory. This will also upload any Markdown files that are located in subdirectories:
42+
43+
$ rdme docs upload documentation/ --version={project-version}
44+
45+
The path input can also be individual Markdown files:
46+
47+
$ rdme docs upload documentation/about.md --version={project-version}
48+
49+
You can omit the `--version` flag to default to the `stable` version of your project:
50+
51+
$ rdme docs upload [path]
52+
53+
This command also has a dry run mode, which can be useful for initial setup and debugging. You can read more about
54+
dry run mode in our docs: https://docs.readme.com/main/docs/rdme#dry-run-mode
55+
56+
$ rdme docs upload [path] --dry-run
57+
58+
FLAG DESCRIPTIONS
59+
--key=<value> ReadMe project API key
60+
61+
An API key for your ReadMe project. Note that API authentication is required despite being omitted from the example
62+
usage. See our docs for more information: https://github.com/readmeio/rdme/tree/v10#authentication
63+
64+
--version=<value> ReadMe project version
65+
66+
Defaults to `stable` (i.e., your main project version).
67+
```
68+
69+
70+
</details>

0 commit comments

Comments
 (0)