Skip to content

Commit 55483a1

Browse files
author
Marek Suchánek
authored
Document snippets; #13
1 parent f46a8c7 commit 55483a1

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Note: The configuration files for a container image are still usable in the repo
141141
modules-dir]$ newdoc --procedure "Setting up thing"
142142
```
143143
144-
The script also accepts the `--concept` and `--reference` options. You can use these short forms instead: `-p`, `-c`, and `-r`.
144+
The tool also accepts the `--concept` and `--reference` options. You can use these short forms instead: `-p`, `-c`, and `-r`.
145145
146146
2. Rewrite the placeholders in the generated file with your docs.
147147
@@ -162,6 +162,18 @@ Note: The configuration files for a container image are still usable in the repo
162162
163163
Alternatively, you can use the `--include-in` option when creating the assembly to generate modules and include them automatically, in a single step. See the description in the *Options* section.
164164
165+
## Creating a new snippet file
166+
167+
1. In the directory where snippets are located, use `newdoc` to create a new file:
168+
169+
```
170+
snippets-dir]$ newdoc --snippet "A reusable note"
171+
```
172+
173+
You can use the short forms instead: `newdoc -s "A reusable note"`.
174+
175+
2. Rewrite the placeholders in the generated file with your docs.
176+
165177
166178
## Validating a file for Red Hat requirements
167179

0 commit comments

Comments
 (0)