GITHUB_MD2HTML(1) Retro Project Manual GITHUB_MD2HTML(1)
NNAAMMEE
github_md2html - convert markdown to HTML with GitHub API
SSYYNNOOPPSSIISS
ggiitthhuubb__mmdd22hhttmmll [_O_P_T_I_O_N]... _F_I_L_E_._._.
DDEESSCCRRIIPPTTIIOONN
Converts Markdown files to HTML using the GitHub converter API. _F_I_L_E
can either be a file name or a directory name (e.g. '.'). If it's a
directory, the whole sub-tree will be scanned and all files with an ex-
tension of _._m_d will be converted. The created HTML files have the ex-
tension _._m_d_._h_t_m_l.
Unless the --ffoorrccee option is given the script checks whether the
_._m_d_._h_t_m_l file already exists and converts only when the markdown file
is newer than the HTML file.
OOPPTTIIOONNSS
--ffoorrccee re-create all files, even when they exist and are up-to-date.
--ssttaannddaalloonnee
modify local links for usage with a local browser. All links
pointing to a local _._m_d file will be redirected to the _._m_d_._h_t_m_l
file and all links pointing to a local directory will be redi-
rected to a _R_E_A_D_M_E_._m_d_._h_t_m_l in case the directory README exists.
This mode is useful when one wants to inspect the files directly
with a browser.
--ttrraaccee trace link mapping in _-_s_t_a_n_d_a_l_o_n_e mode.
--vveerrbboossee
print status of each inspected file. The default is to list only
converted files.
--ccoonntteexxtt _c_o_n_t
defines the GitHub repository context.
--dduummpp print HTTP request and response.
--hheellpp print help text.
EEXXIITT SSTTAATTUUSS
In case of an error, an exit status 1 is returned.
EEXXAAMMPPLLEESS
ggiitthhuubb__mmdd22hhttmmll --ss ..
will convert all _._m_d files in the current sub-tree in standalone
mode.
AAUUTTHHOORR
Walter F.J. Mueller
Retro Project 2018-11-03 GITHUB_MD2HTML(1)