container/podman
container/podman
1
0
Fork 0
mirror of https://github.com/containers/podman synced 2024-10-19 16:54:07 +00:00
Code Issues Packages Projects Releases Wiki Activity
podman/docs
History
Robert P. J. Day 103b5e7807 markdown: fix grammar/formatting, standardize on markdown 
While fixing grammar and list formatting issues, standardize on
markdown as follows:

  - commands are marked by '**'
  - files are marked by backquotes
  - list items are marked with leading '-'

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
2020-01-23 06:59:21 -05:00
..
source markdown: fix grammar/formatting, standardize on markdown 2020-01-23 06:59:21 -05:00
tutorials Markdown Formatting Fixes 2019-10-18 15:38:30 -06:00
varlink make lint: include docs/ 2020-01-14 09:54:48 +01:00
dckrman.sh Add support for mimicing docker CLI 2018-01-18 07:01:48 -05:00
generate.go Rename varlink socket and interface 2018-08-06 14:49:11 +00:00
links-to-html.lua Support podman-remote help on windows 2019-09-19 14:14:38 -07:00
make.bat Restructure documentation dir 2019-10-31 12:31:39 -05:00
Makefile Restructure documentation dir 2019-10-31 12:31:39 -05:00
play.png Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
podman-derivative-api systemd: expect full path /usr/sbin/init 2019-10-09 23:38:45 +02:00
Readme.md Add links to readthedocs on docs/readme 2019-11-04 18:22:41 -05:00
remote-docs.sh Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
requirements.txt Restructure documentation dir 2019-10-31 12:31:39 -05:00

Readme.md

Podman Documentation

The online man pages and other documents regarding Podman can be found at Read The Docs. The man pages can be found under the Commands link on that page.

Build the Docs

Directory Structure

Directory
Markdown source for man pages docs/source/markdown/
man pages aliases as .so files docs/source/markdown/links/
restructured text for readthedocs.io docs/rst/
target for output docs/build
man pages docs/build/man
remote linux man pages docs/build/remote/linux
remote darwin man pages docs/build/remote/darwin
remote windows html pages docs/build/remote/windows

Support files
docs/remote-docs.sh Read the docs/source/markdown files and format for each platform
docs/links-to-html.lua pandoc filter to do aliases for html files