Lines Matching refs:to
14 for converting markdown files to HTML files.
16 The implementation focus is to be **fast** (see [benchmark][]) and **extensible**.
17 Parsing Markdown to HTML is as simple as calling a single method (see [Usage](#usage)) providing a …
20 Extending the Markdown language with new elements is as simple as adding a new method to the class …
21 markdown text to the expected output in HTML. This is possible without dealing with complex and err…
22 It is also possible to hook into the markdown structure and add elements or read meta information u…
27 - **Traditional Markdown** according to <http://daringfireball.net/projects/markdown/syntax> ([try …
28 - **Github flavored Markdown** according to <https://help.github.com/articles/github-flavored-markd…
29 - **Markdown Extra** according to <http://michelf.ca/projects/php-markdown/extra/> (currently not f…
32 Future plans are to support:
35 - ... (Feel free to [suggest](https://github.com/cebe/markdown/issues/new) further additions!)
37 …"PHP is a popular general-purpose scripting language that is especially suited to web development."
52 [PHP 5.4 or higher](http://www.php.net/downloads.php) is required to use it.
55 The library uses PHPDoc annotations to determine the markdown elements that should be parsed.
59 Installation is recommended to be done via [composer][] by running:
63 Alternatively you can add the following to the `require` section in your `composer.json` manually:
73 > Note: If you have configured PHP with opcache you need to enable the
74 …mments) option because inline element parsing relies on PHPdoc annotations to find declared elemen…
81 To parse your markdown you need only two lines of code. The first one is to choose the markdown fla…
88 The next step is to call the `parse()`-method for parsing the text using the full markdown language
89 or calling the `parseParagraph()`-method to parse only inline elements.
115 - `$parser->html5 = true` to enable HTML5 output instead of HTML4.
116 - `$parser->keepListStartNumber = true` to enable keeping the numbers of ordered lists as specified…
117 …The default behavior is to always start from 1 and increment by one regardless of the number in ma…
121 …nableNewlines = true` to convert all newlines to `<br/>`-tags. By default only newlines with two p…
123 It is recommended to use UTF-8 encoding for the input strings. Other encodings may work, but are cu…
127 You can use it to render this readme:
135 or convert the original markdown description to html using the unix pipe:
141 PHP Markdown to HTML converter
149 …--flavor specifies the markdown flavor to use. If omitted the original markdown by John Gruber [1…
171 Convert the original markdown description to html using STDIN:
184 Here are some extensions to this library:
186 - [Bogardo/markdown-codepen](https://github.com/Bogardo/markdown-codepen) - shortcode to embed code…
188 - [cebe/markdown-latex](https://github.com/cebe/markdown-latex) - Convert Markdown to LaTeX and PDF
197 …two types of language elements, I'll call them block and inline elements simlar to what you have in
202 This markdown parser allows you to extend the markdown language by changing existing elements behav…
204 properties. For the different element types there are different ways to extend them as you will see…
208 The markdown is parsed line by line to identify each non-empty line as one of the block element typ…
234 In the above, `$line` is a string containing the content of the current line and is equal to `$line…
235 You may use `$lines` and `$current` to check other lines than the current line. In most cases you c…
239 1. **Consuming** all the lines belonging to it. In most cases this is iterating over the lines star…
243 …he markdown document and the line number to parse next. In the abstract syntax array the first ele…
278 …`render{elementName}()`-method where `elementName` refers to the name of the element in the abstra…
288 …You may also add code highlighting here. In general it would also be possible to render ouput in a…
299 in PHPDoc is needed to register the parse function for one or multiple markers.
302 parsed from the input markdown. All text up to this offset will be removed from the markdown before…
321 …/ return the parsed tag as an element of the abstract syntax tree and call `parseInline()` to allow
342 This markdown library is composed of traits so it is very easy to create your own markdown flavor b…
354 If you want to extend from a flavor and only add features you can use one of the existing classes
357 If you want to define a subset of the markdown language, i.e. remove some of the features, you have…
390 * @var boolean whether to format markup according to HTML5 spec.
391 * Defaults to `false` which means that markup is formatted as HTML4.
406 to get most expected parsing results. Elements are detected in alphabetical order of their identifi…
407 …that if a line starting with `-` could be a list or a horizontal rule, the preference has to be set
408 by renaming the identification function. This is what is done with renaming `identifyHr` to `identi…
409 and `identifyBUl` to `identifyBUl`. The consume function always has to have the same name as the id…
410 so this has to be renamed too.
413 or an inline HTML tag. In order to resolve this conflict when adding the `LinkTrait`, we need to hi…
416 If you use any trait that uses the `$html5` property to adjust its output you also need to define t…
418 If you use the link trait it may be useful to implement `prepare()` as shown above to reset referen…
419 parsing to ensure you get a reusable object.
424 …llowing is the set of escapeable characters for traditional markdown, you can copy it to your class
452 Optionally you may also want to adjust rendering behavior by overriding some methods.
453 You may refer to the `consumeParagraph()` method of the `Markdown` and `GithubMarkdown` classes for…
454 which define different rules for which elements are allowed to interrupt a paragraph.
460 I'd like to thank [@erusev][] for creating [Parsedown][] which heavily influenced this work and pro…
471 While reviewing PHP markdown parsers for choosing one to use bundled with the [Yii framework 2.0][]
472 I found that most of the implementations use regex to replace patterns instead
474 as you have to come up with a complex regex, that matches your addition but does not mess
484 Given the situation above I decided to start my own implementation using the parsing approach
487 This allows you to choose between markdown language flavors and also provides a way to compose your
489 I chose this approach as it is easier to implement and also more intuitive approach compared
490 to using callbacks to inject functionallity into the parser.
500 …e the problem. You may also attach screenshots of the rendered HTML result to describe your proble…
504 ### How can I contribute to this library?
509 ### Am I free to use this?
521 Feel free to contact me using [email](mailto:mail@cebe.cc) or [twitter](https://twitter.com/cebe_cc…