Skip to content

Commit

Permalink
dropped .md from doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
mathiasverraes committed Jun 25, 2020
1 parent 7a62438 commit 2337afa
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 19 deletions.
32 changes: 16 additions & 16 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,32 +7,32 @@ The easiest way to build robust parsers in PHP.

**Note:** Parsica is very early stage, expect things to break.

* [Installation & Requirements](installation.md)
* [API Reference](api/index.md)
* [Installation & Requirements](installation)
* [API Reference](api/index)

## Tutorial

1. [What are parser combinators?](tutorial/introduction.md)
1. [Building Blocks](tutorial/building_blocks.md)
1. [Running Parsers](tutorial/running_parsers.md)
1. [Mapping to Objects](tutorial/mapping_to_objects.md)
1. [Order Matters](tutorial/order_matters.md)
1. [Recursion](tutorial/recursion.md)
1. [Look Ahead](tutorial/look_ahead.md)
1. [What are parser combinators?](tutorial/introduction)
1. [Building Blocks](tutorial/building_blocks)
1. [Running Parsers](tutorial/running_parsers)
1. [Mapping to Objects](tutorial/mapping_to_objects)
1. [Order Matters](tutorial/order_matters)
1. [Recursion](tutorial/recursion)
1. [Look Ahead](tutorial/look_ahead)

## Resources

* [Development Status](resources/development_status.md)
* [Performance](resources/performance.md)
* [Naming Conventions](resources/naming_conventions.md)
* [Functional Paradigms](resources/functional_paradigms.md)
* [Development Status](resources/development_status)
* [Performance](resources/performance)
* [Naming Conventions](resources/naming_conventions)
* [Functional Paradigms](resources/functional_paradigms)

## Contribute

* [Donate via Paypal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=NS4GQXUDXRKQJ&source=url). This project was researched and created entirely during unpaid time. Your contribution helps us with continued development.
* [Design Goals](contribute/design_goals.md)
* [Design Goals](contribute/design_goals)
* Contribute by submitting code, documentation, examples, ... through pull requests.
* [Code of Conduct](CODE_OF_CONDUCT.md)
* [Code of Conduct](CODE_OF_CONDUCT)

## Support

Expand All @@ -50,5 +50,5 @@ Submit questions as Github issues. Please label them with 'support'. Help us hel
* Twitter: [@parsica_php](https://twitter.com/parsica_php)
* GitHub: [mathiasverraes/parsica](https://github.com/mathiasverraes/parsica)
* Packagist: [mathiasverraes/parsica](https://packagist.org/packages/mathiasverraes/parsica)
* License: [MIT](LICENSE.md)
* License: [MIT](LICENSE)
* Donate: [Paypal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=NS4GQXUDXRKQJ&source=url)
2 changes: 1 addition & 1 deletion docs/resources/functional_paradigms.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Throughout this document, `$parser1 ≡ $parser2` means that you can swap `$pars

## Purity

Almost all the code is pure and referentially transparent. [A notable exception](recursion.md) is the combo of `recursive()` and `Parser::recurse()`. The latter mutates a `Parser`. We constrained this so that you can't use the parser when it's not set up yet, and after calling `recurse()`, you can't call it again. So not strictly pure, but close enough not to matter much in practice.
Almost all the code is pure and referentially transparent. [A notable exception](recursion) is the combo of `recursive()` and `Parser::recurse()`. The latter mutates a `Parser`. We constrained this so that you can't use the parser when it's not set up yet, and after calling `recurse()`, you can't call it again. So not strictly pure, but close enough not to matter much in practice.

The combinators are all pure. Some combinators are implemented as instance methods on `Parser`, but these are also pure. You can think of them as functions that take `$this` as the first argument.

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: What are parser combinators?
---

Before you start, make sure you've had a look at the [installation instructions](installation.md).
Before you start, make sure you've had a look at the [installation instructions](installation).


## Parsers
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/running_parsers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ There ar two ways of running your parser on an input.

Most of the time, you'll want to use `try`. It will run the parser, return a `ParseResult` on success, and throw a `ParserFailure` exception if the input can't successfully be parsed.

`ParseResult` has an `output()` method, which has the type `T` for a `Parser<T>` (see [Mapping to Objects](mapping_to_objects.md)). It also has a `remainder()` method, which gives you the part of the input that wasn't consumed by the parser.
`ParseResult` has an `output()` method, which has the type `T` for a `Parser<T>` (see [Mapping to Objects](mapping_to_objects)). It also has a `remainder()` method, which gives you the part of the input that wasn't consumed by the parser.

`ParserFailure` has the usual `Exception` methods, and

Expand Down

0 comments on commit 2337afa

Please sign in to comment.