You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-1Lines changed: 13 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -141,7 +141,7 @@ Note: The configuration files for a container image are still usable in the repo
141
141
modules-dir]$ newdoc --procedure "Setting up thing"
142
142
```
143
143
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`.
145
145
146
146
2. Rewrite the placeholders in the generated file with your docs.
147
147
@@ -162,6 +162,18 @@ Note: The configuration files for a container image are still usable in the repo
162
162
163
163
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.
164
164
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.
0 commit comments