kramdown - Online na nuvem

PROGRAMA:

NOME

kramdown - um conversor superconjunto de Ruby Markdown rápido e puro

SINOPSE

Kramdown [opções] [ARQUIVO ...]

DESCRIÇÃO

kramdown é usado principalmente para analisar um superconjunto de Markdown e convertê-lo para
diferentes formatos de saída. Suporta Markdown padrão (com algumas pequenas modificações)
e várias extensões, como tabelas e listas de definição. Devido à sua arquitetura modular
também permite outros formatos de entrada além do Markdown, por exemplo, HTML ou Github Flavored
Remarcação.

If ARQUIVO não for especificado, kramdown lê a entrada padrão. O resultado é escrito para
a saída padrão.

Existem dois conjuntos de opções que o kramdown aceita: O primeiro inclui as opções
que são usados ​​diretamente pelo binário kramdown. O segundo conjunto de opções controla como
kramdown analisa e converte sua entrada.

OPÇÕES

-eu, --entrada ARG
Especifique o formato de entrada. Formatos de entrada disponíveis: kramdown (este é o padrão),
markdown, GFM ou html.

-ó, --resultado ARG
Especifique um ou mais formatos de saída separados por vírgulas: html (padrão), kramdown,
latex, pdf ou remove_html_tags.

-dentro, --versão
Mostra a versão do kramdown.

-h, --Socorro
Mostre a ajuda.

KRAMDOWN OPÇÕES

--auto-id-prefixo ARG

Prefixo usado para IDs de cabeçalho gerados automaticamente

Esta opção pode ser usada para definir um prefixo para os IDs de cabeçalho gerados automaticamente
para que não haja conflito ao renderizar vários documentos kramdown em um
arquivo de saída separadamente. O prefixo deve conter apenas caracteres válidos em
um ID!

Padrão: '' Usado por: conversor de HTML / Latex

- [sem-] auto-id-stripping

Remova toda a formatação do texto do cabeçalho para geração automática de ID

Se esta opção for `true`, apenas os elementos de texto de um cabeçalho são usados ​​para
gerar o ID posteriormente (em contraste com apenas usar a linha de texto do cabeçalho bruto).

Esta opção será removida na versão 2.0 porque será o padrão.

Padrão: falso Usado por: analisador kramdown

- [sem-] ids automáticos

Use a geração automática de ID de cabeçalho

Se esta opção for `true`, os valores de ID para todos os cabeçalhos são gerados automaticamente se
nenhum ID é especificado explicitamente.

Padrão: verdadeiro Usado por: conversor de HTML / Latex

--coderay-bold-every ARG

Define com que freqüência um número de linha deve ser colocado em negrito

Pode ser um número inteiro ou falso (para desativar completamente os números das linhas em negrito).

Padrão: 10 Usado por: conversor de HTML

--coderay-css ARG

Define como o código destacado é estilizado

Os valores possíveis são: class (classes CSS são aplicadas aos elementos do código, é necessário
forneça o arquivo CSS necessário) ou: style (os estilos CSS padrão são aplicados diretamente ao
os elementos do código).

Padrão: estilo usado por: conversor de HTML

--coderay-default-lang ARG

Define o idioma padrão para destacar blocos de código

Se nenhum idioma for definido para um bloco de código, o idioma padrão será usado. o
o valor deve ser uma das linguagens suportadas pelo coderay ou nil se não houver padrão
linguagem deve ser usada.

Padrão: nil Usado por: conversor de HTML

--coderay-linha-número-início ARG

O valor inicial para os números de linha

Padrão: 1 Usado por: conversor de HTML

--coderay-line-numbers ARG

Define como e se os números de linha devem ser mostrados

Os valores possíveis são: table,: inline ou nil. Se esta opção for nula, nenhuma linha
números são mostrados.

Padrão:: embutido Usado por: conversor de HTML

--coderay-tab-largura ARG

A largura da tabulação usada no código destacado

Usado por: conversor de HTML

--coderay- wrap ARG

Define como o código destacado deve ser empacotado

Os valores possíveis são: span,: div ou nil.

Padrão:: div Usado por: conversor de HTML

- [no-] enable-coderay

Use coderay para destaque de sintaxe

Se esta opção for `true`, coderay é usado pelo conversor de HTML para sintaxe
destacando o conteúdo de extensões de código e blocos de código.

Padrão: verdadeiro usado por: conversor de HTML

--entidade-saída ARG

Define como as entidades são geradas

Os valores possíveis são: as_input (as entidades são geradas na mesma forma que encontradas em
a entrada),: numérico (as entidades são geradas na forma numérica),: simbólico (as entidades são
saída em forma simbólica, se possível) ou: as_char (entidades são geradas como caracteres
se possível, disponível apenas no Ruby 1.9).

Padrão:: as_char Usado por: conversor de HTML, conversor de kramdown

--footnote-backlink ARG

Define o texto que deve ser usado para os backlinks das notas de rodapé

O backlink da nota de rodapé é apenas texto, portanto, qualquer caractere HTML especial terá escape.

Se o texto do backlint da nota de rodapé for uma string vazia, nenhum backlint da nota de rodapé será
gerado.

Padrão: '& 8617;' Usado por: conversor de HTML

--nota de rodapé-nr ARG

O número da primeira nota de rodapé

Esta opção pode ser usada para especificar o número que é usado para a primeira nota de rodapé.

Padrão: 1 Usado por: conversor de HTML

- [sem-] capa dura

Interpreta as quebras de linha literalmente

Inserir HTML ` `tags dentro de parágrafos onde o documento Markdown original
tinha novas linhas (por padrão, o Markdown ignora essas novas linhas).

Padrão: verdadeiro usado por: analisador GFM

--header-offset ARG

Define o deslocamento de saída para cabeçalhos

Se esta opção for c (também pode ser negativa), um cabeçalho com nível n será
saída como um cabeçalho com nível c + n. Se c + n for menor que 1, o nível 1 será usado. Se
c + n é maior que 6, o nível 6 será usado.

Padrão: 0 Usado por: conversor de HTML, conversor de Kramdown, conversor de Látex

- [no-] html-para-nativo

Converter elementos HTML em elementos nativos

Se esta opção for `true`, o analisador converte os elementos HTML em elementos nativos. Para
exemplo, ao analisar ` hallo` , a tag de ênfase normalmente seria convertida
para um elemento `: html` com tipo de tag`: em`. Se `html_to_native` for` true`, então o
a ênfase seria convertida em um elemento `: em` nativo.

Isso é útil para conversores que não conseguem lidar com elementos HTML.

Padrão: falso Usado por: analisador kramdown

--cabeçalhos de látex ARG

Define os comandos LaTeX para diferentes níveis de cabeçalho

Os comandos para os níveis de cabeçalho de um a seis podem ser especificados separando-os
com vírgulas.

Padrão: seção, subseção, subseção, parágrafo, subparágrafo, subparágrafo Usado
por: conversor de látex

--espessura da linha ARG

Define a largura da linha a ser usada na saída de um documento

Padrão: 72 Usado por: conversor kramdown

--link-defs ARG

Pré-define definições de link

Esta opção pode ser usada para predefinir as definições do link. O valor precisa ser um
Hash onde as chaves são os identificadores do link e os valores são dois elementos Arrays
com o URL do link e o título do link.

Se o valor for uma String, ele deve conter um hash YAML válido e o hash deve
siga as diretrizes acima.

Padrão: {} usado por: analisador kramdown

--motor matemático ARG

Defina o motor matemático

Especifica o mecanismo matemático que deve ser usado para converter blocos / extensões matemáticas. Se
esta opção é definida como + nil +, nenhum mecanismo matemático é usado e os blocos / extensões matemáticas são
saída como está.

As opções para o mecanismo matemático selecionado podem ser definidas com o math_engine_opts
opção de configuração.

Padrão: mathjax Usado por: conversor de HTML

--math-engine-opts ARG

Defina as opções do motor matemático

Especifica opções para o mecanismo matemático definido por meio da opção de configuração math_engine.

O valor precisa ser um hash com pares de valores-chave que são compreendidos pelo
motor matemático.

Padrão: {} usado por: conversor de HTML

- [no-] parse-block-html

Sintaxe de kramdown de processo em tags HTML de bloco

Se esta opção for `true`, o analisador kramdown processa o conteúdo do bloco HTML
tags como texto contendo elementos de nível de bloco. Uma vez que isso não é desejado normalmente,
o padrão é `false`. Normalmente é melhor habilitar seletivamente o kramdown
processamento por meio do atributo markdown.

Padrão: falso Usado por: analisador kramdown

- [no-] parse-span-html

Sintaxe de kramdown de processo em tags HTML span

Se esta opção for `true`, o analisador kramdown processa o conteúdo de span HTML
tags como texto contendo elementos de nível de span.

Padrão: verdadeiro usado por: analisador kramdown

- [no-] remove-block-html-tags

Remover tags HTML de bloqueio

Se esta opção for `true`, o conversor RemoveHtmlTags remove as tags HTML de bloqueio.

Padrão: verdadeiro Usado por: conversor RemoveHtmlTags

- [no-] remove-span-html-tags

Remover tags HTML span

Se esta opção for `true`, o conversor RemoveHtmlTags remove as tags HTML span.

Padrão: falso Usado por: conversor RemoveHtmlTags

--aspas inteligentes ARG

Define os nomes de entidade HTML ou pontos de código para saída de cotação inteligente

As entidades identificadas pelo nome da entidade ou ponto de código que deve ser usado para, em
pedido, uma aspa simples à esquerda, uma aspa simples à direita, um duplo à esquerda e um duplo à direita
aspas são especificadas separando-as com vírgulas.

Padrão: lsquo, rsquo, ldquo, rdquo Usado por: conversor de HTML / Latex

--sintaxe-realçador ARG

Defina o realce de sintaxe

Especifica o realce de sintaxe que deve ser usado para realçar blocos de código
e vãos. Se esta opção for definida como + nil +, nenhum destaque de sintaxe é feito.

As opções para o realce de sintaxe podem ser definidas com syntax_highlighter_opts
opção de configuração.

Padrão: coderay Usado por: conversor de HTML / Latex

--syntax-highlighter-opts ARG

Defina as opções do realce de sintaxe

Especifica opções para o realce de sintaxe definido por meio do syntax_highlighter
opção de configuração.

O valor precisa ser um hash com pares de valores-chave que são compreendidos pelo
marcador de sintaxe.

Padrão: {} usado por: conversor de HTML / Latex

--modelo ARG

O nome de um arquivo de modelo ERB que deve ser usado para envolver a saída ou o ERB
modelo em si.

Isso é usado para envolver a saída em um ambiente para que a saída possa ser usada como
um documento autônomo. Por exemplo, um modelo HTML forneceria o necessário
tags de cabeçalho e corpo para que toda a saída seja um arquivo HTML válido. Se nenhum modelo
for especificado, a saída será apenas o texto convertido.

Ao resolver o arquivo de modelo, o nome do modelo fornecido é usado primeiro. Se tal
arquivo não for encontrado, a extensão do conversor (o mesmo que o nome do conversor) é
anexado. Se o arquivo ainda não foi encontrado, o nome do modelo é interpretado como um
nome do modelo fornecido por kramdown (sem a extensão do conversor). Se
o arquivo ainda não foi encontrado, o nome do modelo é verificado se começar com
'string: //' e em caso afirmativo, este prefixo é removido e o resto é usado como modelo
conteúdo.

kramdown fornece um modelo padrão denominado 'documento' para cada conversor.

Padrão: '' Usado por: todos os conversores

--toc-níveis ARG

Define os níveis que são usados ​​para o índice

Os níveis individuais podem ser especificados separando-os com vírgulas (por exemplo, 1,2,3)
ou usando a sintaxe de intervalo (por exemplo, 1..3). Apenas os níveis especificados são usados ​​para
o índice.

Padrão: 1..6 Usado por: conversor de HTML / Latex

- [no-] transliterated-header-ids

Transliterar o texto do cabeçalho antes de gerar o ID

Apenas caracteres ASCII são usados ​​em IDs de cabeçalhos. Isso não é bom para idiomas com
muitos caracteres não ASCII. Ao ativar esta opção, o texto do cabeçalho é
transliterado para ASCII o melhor possível para que o ID do cabeçalho resultante seja mais
útil.

A biblioteca stringex precisa ser instalada para que este recurso funcione!

Padrão: falso Usado por: conversor de HTML / Latex

SAIR STATUS

O status de saída é 0 se nenhum erro tiver acontecido. Caso contrário, é 1.

Use kramdown online usando serviços onworks.net