Skip to content

Commit d80c0a9

Browse files
committed
Initial commit
0 parents  commit d80c0a9

File tree

4 files changed

+92
-0
lines changed

4 files changed

+92
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/vendor/
2+
composer.lock

LICENSE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
The MIT License
2+
===============
3+
4+
Copyright (c) 2016 czukowski <https://github.com/czukowski>
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
7+
associated documentation files (the "Software"), to deal in the Software without restriction,
8+
including without limitation the rights to use, copy, modify, merge, publish, distribute,
9+
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all copies or substantial
13+
portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
16+
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
18+
OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Table of Contents generator for cebe/markdown
2+
=============================================
3+
4+
This package provides a PHP _trait_ that to use with [cebe's Markdown implementation][cebe/markdown].
5+
It allows to generate ToC from headlines in Makrdown documents and render them as lists.
6+
7+
Installation
8+
------------
9+
10+
Recommended installation is via [composer][composer] by running:
11+
12+
composer require czukowski/markdown-toc "~1.0"
13+
14+
Alternatively you may add the following to the `require` section of your project's `composer.json`
15+
manually and then run `composer update` from the command line:
16+
17+
```json
18+
"czukowski/markdown-toc: "~1.0"
19+
```
20+
21+
Usage
22+
-----
23+
24+
This package provides a `TOCTrait` that may be used in classes extending the cebe's original Markdown
25+
parsers.
26+
27+
For more information on how to extend the parser, refer to the [original Readme file][markdown-usage].
28+
29+
License
30+
-------
31+
32+
The distribution is permitted under the MIT License. See LICENSE.md for details.
33+
34+
35+
[cebe/markdown]: https://github.com/cebe/markdown
36+
[composer]: https://getcomposer.org/
37+
[markdown-usage]: https://github.com/cebe/markdown#usage

composer.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"name": "czukowski/markdown-toc",
3+
"type": "library",
4+
"description": "Table of Contents generator for cebe/markdown",
5+
"keywords": ["markdown", "toc", "table of contents", "index"],
6+
"homepage": "https://github.com/czukowski/markdown-toc",
7+
"license": "MIT",
8+
"authors": [
9+
{
10+
"name": "Korney Czukowski",
11+
"homepage": "http://xn----0tbl7bn.com"
12+
}
13+
],
14+
"support": {
15+
"issues": "https://github.com/czukowski/markdown-toc/issues"
16+
},
17+
"require": {
18+
"php": ">=5.4.0",
19+
"cebe/markdown": "~1.1.0"
20+
},
21+
"require-dev": {
22+
"phpunit/phpunit": "~4.7"
23+
},
24+
"autoload": {
25+
"psr-4": {
26+
"Cz\\Markdown\\": "classes"
27+
}
28+
},
29+
"autoload-dev": {
30+
"psr-4": {
31+
"Cz\\Markdown\\": "tests"
32+
}
33+
}
34+
}

0 commit comments

Comments
 (0)