Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): fix option for template overriding in example #92

Merged
merged 3 commits into from
Jun 11, 2023
Merged

docs(readme): fix option for template overriding in example #92

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98058fd
docs(readme): fix option for template overriding in example
ccamel Jun 7, 2023
2464659
port fix to doc.go
princjef Jun 11, 2023
510460c
Merge branch 'master' into docs/fix-template-opt
princjef Jun 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,10 @@ The documentation information that is output is formatted using a series of text

- import: generates the import code used to pull in a package.

Overriding with the \-t option uses a key\-vaule pair mapping a template name to the file containing the contents of the override template to use. Specified template files must exist:
Overriding with the \-\-template\-file option uses a key\-value pair mapping a template name to the file containing the contents of the override template to use. Specified template files must exist:

```
gomarkdoc -t package=custom-package.gotxt -t doc=custom-doc.gotxt .
gomarkdoc --template-file package=custom-package.gotxt --template-file doc=custom-doc.gotxt .
```

### Additional Options
Expand Down
8 changes: 4 additions & 4 deletions doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@
//
// - import: generates the import code used to pull in a package.
//
// Overriding with the -t option uses a key-vaule pair mapping a template name
// to the file containing the contents of the override template to use.
// Specified template files must exist:
// Overriding with the --template-file option uses a key-value pair mapping a
// template name to the file containing the contents of the override template to
// use. Specified template files must exist:
//
// gomarkdoc -t package=custom-package.gotxt -t doc=custom-doc.gotxt .
// gomarkdoc --template-file package=custom-package.gotxt --template-file doc=custom-doc.gotxt .
//
// # Additional Options
//
Expand Down