7244f7d42f
update cli-docs-tool to v0.9.0
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2025-01-13 18:59:22 +01:00
64a3fb82dc
docs: fix typos and version for cli-docs-tool scripts
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2024-07-17 15:25:37 +02:00
8549d250f6
docs: update cli-docs-tool (v0.8.0)
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-07-04 10:28:53 +02:00
e244044944
deps: update cli-docs-tool version (v0.7.0)
...
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com >
2024-02-20 08:31:53 +01:00
1e3622c50c
docs: move doc generation scripts to subdir
...
Signed-off-by: David Karlsson <david.karlsson@docker.com >
2023-01-31 06:33:23 +01:00
79c9e527a3
docs: generate markdown
...
Keep frontmatter for docker, dockerd and index markdown files.
Also needs to move cli.md > docker.md before generation and
then move it back because cli.md is needed for yaml generation on docs
website: https://github.com/docker/cli/pull/3924#discussion_r1059986605
Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com >
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2023-01-06 22:36:47 +01:00
c49f1ccb49
update cli-docs-tool to v0.5.1
...
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com >
2023-01-06 19:15:34 +01:00
6eec719d39
update cli-docs-tool to v0.5.0
...
release notes: https://github.com/docker/cli-docs-tool/releases/tag/v0.5.0
full diff: https://github.com/docker/cli-docs-tool/compare/v0.3.1...v0.5.0
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2022-08-17 16:56:44 +02:00
a650f4ddd0
switch to cli-docs-tool for yaml docs generation
...
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com >
switch to cli-docs-tool and validate yamldocs
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com >
2022-02-25 17:11:16 +01:00
c509ef7104
yamldocs: various improvements
...
- make sure the target directory is created if missing
- add support for custom ID's in headings through `<a>` tags (e.g.
`<a name=heading2></a>`). This allows use of custom anchors that
work both on GitHub (GFM doesn't support extended MarkDown), and
in Jekyll (which does).
- add code to cleanup markdown for use in our docs:
- remove absolute URLs to https://docs.docker.com
- remove tabs in MarkDown, and convert them to 4 spaces. This
prevents the YAML conversion from switching between "short"
and "long" syntax. Tabs in code examples also don't always
work well, so using spaces doesn't hurt for that.
- refactor some code for readability, and to be less "hacky" (still
lots to be improved though)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl >
2021-07-30 20:43:22 +02:00
24c06c1723
Add scripts folder to shellcheck
...
Signed-off-by: Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr >
2017-07-19 16:33:58 +01:00
343d836a95
Run docs and man generation in CI
...
Also cleanup the scripts a bit to be more consistent, and fail on errors.
Signed-off-by: Daniel Nephin <dnephin@docker.com >
2017-06-14 14:59:48 -07:00
ff615dbc4d
Add scripts and targets for manpages and yamldocs
...
Signed-off-by: Tibor Vass <tibor@docker.com >
2017-06-05 19:10:44 +00:00
