Markdown to html linux

markdown (1) — Linux Manuals

The utility reads the markdown(7)Ns-formatted textfile (or stdin if not specified,) compiles it, and writes the html output to stdout.

The options are as follows:

-b url-base Links in source beginning with / will be prefixed with url-base in the output. -C When processing markdown extra-style footnotes, use the given prefix instead of the default of fn -d Instead of writing the html file, dump a parse tree to stdout. -f flags Set or clear various translation flags. The flags are in a comma-delimited list, with an optional + (enable), — (disable), or no (disable) lprefix on each flag.

links Allow links. image Allow images. smarty Enable smartypants. pants Enable smartypants. html Allow raw html. strict Disable superscript, strikethrough & relaxed emphasis. ext Enable pseudo-protocols. cdata Generate code for xml ![CDATA[. ]] superscript Enable superscript processing. emphasis Emphasis happens everywhere tables Don’t process PHP Markdown Extra tables. del Enable ~~strikethrough~~ strikethrough Enable ~~strikethrough~~ toc Enable table-of-contents processing. 1.0 Compatibility with MarkdownTest_1.0 autolink Make http://foo.com a link even without <> safelink Paranoid check for link protocol. header Process pandoc-style header blocks. tabstop Expand tabs to 4 spaces. divquote Allow >%class% blocks. alphalist Allow alphabetic lists. definitionlist Allow definition lists. footnote Allow markdown extra-style footnotes. styles Extract blocks from the output.

As an example, the option —f nolinks,smarty tells to not allow

-F bitmap Set translation flags. Bitmap is a bit map of the various configuration options described in markdown(3) (the flag values are defined in mkdio.h -n Don’t write generated html. -o file Write the generated html to file -S output blocks. -V Show the version# and compile-time configuration data.

If the version includes the string DEBUG was configured with memory allocation debugging.

If the version includes the string TAB was configured to use the specified tabstop.

Источник

markdown(1) — Linux man page

The markdown utility reads the markdown(7)-formatted textfile (or stdin if not specified,) compiles it, and writes the html output to stdout.

The options are as follows:

-C‘ When processing markdown extra-style footnotes, use the given prefix instead of the default of fn.

-d‘ Instead of writing the html file, dump a parse tree to stdout.

-f flags
Set or clear various translation flags. The flags are in a comma-delimited list, with an optional + (enable), — (disable), or no (disable) lprefix on each flag.

smarty‘ Enable smartypants.

pants‘ Enable smartypants.

strict‘ Disable superscript, strikethrough & relaxed emphasis.

ext‘ Enable pseudo-protocols.

cdata‘ Generate code for xml ![CDATA[. ]].

superscript‘ Enable superscript processing.

emphasis‘ Emphasis happens everywhere.

tables‘ Don’t process PHP Markdown Extra tables.

del‘ Enable ~~strikethrough~~.

strikethrough
Enable ~~strikethrough~~.

toc‘ Enable table-of-contents processing.

1.0‘ Compatibility with MarkdownTest_1.0

autolink‘ Make http://foo.com a link even without <>.

safelink‘ Paranoid check for link protocol.

header‘ Process pandoc-style header blocks.

tabstop‘ Expand tabs to 4 spaces.

divquote‘ Allow >%class% blocks.

alphalist‘ Allow alphabetic lists.

definitionlist
Allow definition lists.

footnote‘ Allow markdown extra-style footnotes.

As an example, the option -f nolinks,smarty tells markdown to not allow

-F bitmap
Set translation flags. Bitmap is a bit map of the various configuration options described in markdown(3) (the flag values are defined in mkdio.h)

-V‘ Show the version# and compile-time configuration data.

If the version includes the string DEBUG, markdown was configured with memory allocation debugging.

If the version includes the string TAB, markdown was configured to use the specified tabstop.

-VV‘ Show the version#, the compile-time configuration, and the run-time configuration.

-o file
Write the generated html to file.

-t text
Use mkd_text(3) to format text instead of processing stdin with the markdown(3) function.

-T‘ If run with the table-of-content flag on, dump the table of contents before the formatted text.

-s text
Use the markdown(3) function to format text.

Return Values

The markdown utility exits 0 on success, and >0 if an error occurs.

See Also

Author

MASTODON January 7, 2008 MASTODON

Источник

Markdown to html linux

NAME

markdown — text to html conversion tool

SYNOPSIS

markdown [-d] [-T] [-V] [-b url-base] [-C prefix] [-F bitmap] [-f flags] [-n] [-o file] [-S] [-s text] [-t text] [textfile]

DESCRIPTION

The markdown utility reads the markdown(7)-formatted textfile (or stdin if not specified,) compiles it, and writes the html output to stdout. The options are as follows: -b url-base Links in source beginning with / will be prefixed with url-base in the output. -C When processing markdown extra-style footnotes, use the given prefix instead of the default of fn. -d Instead of writing the html file, dump a parse tree to stdout. -f flags Set or clear various translation flags. The flags are in a comma-delimited list, with an optional + (enable), - (disable), or no (disable) lprefix on each flag. links Allow links. image Allow images. smarty Enable smartypants. pants Enable smartypants. html Allow raw html. strict Disable superscript, strikethrough & relaxed emphasis. ext Enable pseudo-protocols. cdata Generate code for xml ![CDATA[. ]]. superscript Enable superscript processing. emphasis Emphasis happens everywhere. tables Don't process PHP Markdown Extra tables. del Enable ~~strikethrough~~. strikethrough Enable ~~strikethrough~~. toc Enable table-of-contents processing. 1.0 Compatibility with MarkdownTest_1.0 autolink Make http://foo.com a link even without <>. safelink Paranoid check for link protocol. header Process pandoc-style header blocks. tabstop Expand tabs to 4 spaces. divquote Allow >%class% blocks. alphalist Allow alphabetic lists. definitionlist Allow definition lists at all (default). Use dldiscount and dlextra to control which syntaxes are respected. dldiscount Enable discount-style definition lists (default). dlextra Enable extra-style definition lists (not default). Both styles may be enabled simultaneously. footnote Allow markdown extra-style footnotes. style Extract blocks from the output. fencedcode Allow fenced code blocks (not default). idanchor Use for table-of-contents links instead of (not default). githubtags Allow underscore and dash in passed through element names (not default). urlencodedanchor Use url-encoded chars for multibyte and nonalphanumeric chars rather than dots in toc links. As an example, the option -f nolinks,smarty tells markdown to not allow -F bitmap Set translation flags. Bitmap is a bit map of the various configuration options described in markdown(3) (the flag values are defined in mkdio.h) -n Don't write generated html. -o file Write the generated html to file. -S output blocks. -V Show the version# and compile-time configuration data. If the version includes the string DEBUG, markdown was configured with memory allocation debugging. If the version includes the string TAB, markdown was configured to use the specified tabstop. -VV Show the version#, the compile-time configuration, and the run-time configuration. -t text Use mkd_text(3) to format text instead of processing stdin with the markdown(3) function. -T If run with the table-of-content flag on, dump the table of contents before the formatted text. -s text Use the markdown(3) function to format text.

RETURN VALUES

The markdown utility exits 0 on success, and >0 if an error occurs.

SEE ALSO

markdown(3), markdown(7), mkd-extensions(7).

Источник

Saved searches

Use saved searches to filter your results more quickly

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.

Markdown to html documentation with custom templates.

cnam/md2html

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Sign In Required

Please sign in to use Codespaces.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

Git stats

Files

Failed to load latest commit information.

README.md

Markdown to html page generator

For create beautiful documentation from your wiki or your documentation in repository. Your may be use multiply repositories wiki for create one portal with documentation.

We may be use beautiful templates for generate documentation or added your custom template.

You do not need anything except to git, because md2html created in golang and compile to binary

We may be use installation from binary or with docker

wget https://github.com/cnam/md2html/releases/download/0.2.0/darwin_md2html mv darwin_md2html /usr/local/bin/md2html chmod +x /usr/local/bin/md2html

wget https://github.com/cnam/md2html/releases/download/0.2.0/linux_md2html mv linux_md2html /usr/local/bin/md2html chmod +x /usr/local/bin/md2html

We assume that you have already installed Docker

docker pull cnam/md2html:latest docker run -v wiki.dir:wiki.dir \ -v documentation:documentation \ -v template_dir:template_dir \ cnam/md2html:latest -i wiki.dir -o documentation -t template_dir/template.tpl -p /docs

md2html -i wiki.dir -o documentation -t template.tpl -p /docs

• -i or —input Directory with markdown files
• -o or —output Directory for output generated html files
• -t or —template Template for generated documentation
• -p or —path Subdirectory in site eg /docs where documentation location
• -s or —sidebar Path to your custom sidebar

Your must be create html template with variables example

Default Variables

• > Page title similarly filename
• > Custom sidebar for view menu, html represents in file _Sidebar.md
• > List pages for generate sidebar automatically. it contains
  • > Name page from generated
  • > url to the pages

  ul> li>a href pl-s">/docs">Homea>li> > li>a href pl-s">/>">>a>li> > ul>

  Sidebar as static sidebar

  Mixed sidebar as html page and static

  > > > ul> li>a href pl-s">/docs">Homea>li> > li>a href pl-s">/>">>a>li> > > ul> >

  Create sidebar as static file

  In order to make your sidebar in each sub-directory, he can be your own or a common, if it is set within a directory in the root of the documentation.

  Sidebar represents as _Sidebar.md file and allow markdown syntax

  About

  Markdown to html documentation with custom templates.

  Источник