Skip to content
This repository was archived by the owner on Jun 23, 2021. It is now read-only.

Commit fe0f62c

Browse files
authored
Update README.md
1 parent 09a86b4 commit fe0f62c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Pastel is a PHP tool to generate beautiful documentation from Markdown. [Here's
88
<img src="./screenshots/pastel-screenshot-1.png">
99
</p>
1010

11-
This project is a fork of [Documentarian](https://github.com/knuckleswtf/pastel), which is itself a PHP port of [Slate](https://github.com/slatedocs/slate), the API documentation tool.
11+
This project was forked from [Documentarian](https://github.com/knuckleswtf/pastel), which is itself a PHP port of [Slate](https://github.com/slatedocs/slate), the API documentation tool.
1212

1313
## Table of contents
1414
- [Installation](#installation)
@@ -20,7 +20,7 @@ This project is a fork of [Documentarian](https://github.com/knuckleswtf/pastel)
2020

2121
## Installation
2222
```bash
23-
composer require knuckleswtf/pastel
23+
composer require --dev knuckleswtf/pastel
2424
```
2525

2626
## Usage
@@ -30,9 +30,9 @@ Pastel is like Documentarian and Slate, but simpler and with a somewhat differen
3030
Start off with a single Markdown file. There are two parts:
3131

3232
#### The content
33-
Your Markdown file should contain your docs, written as you like. There's no set format, but you can start with an introduction, talk about authentication and any general details, then describe each endpoint in its own section. Write example requests and responses using code blocks, use tables to describe request and response parameters.
33+
Your Markdown file should contain your docs, written as you like. There's no set format, but you can start with an introduction, talk about authentication and any general details, then describe each endpoint in its own section. Write example requests and responses using code blocks, use tables or paragraphs to describe request and response parameters.
3434

35-
There's a good example in the included example Markdown ([stubs/index.md](./stubs/index.md)) and the resulting HTML output ([docs/index.html](./docs/index.html)).
35+
There's a good example in the included example Markdown ([stubs/index.md](./stubs/index.md)) and the resulting HTML output ([docs/index.html](./docs/index.html)).
3636

3737
For a full explanation of the supported Markdown syntax, see [How to Edit Slate Markdown files](https://github.com/slatedocs/slate/wiki/Markdown-Syntax)
3838

@@ -145,4 +145,4 @@ You can help your lower-level headings stand out by using the `fancy-heading-pan
145145
- [laravel-apidoc-generator](https://github.com/mpociot/laravel-apidoc-generator): Generate documentation for your Laravel APIs from your codebase. Built by the creator of Documentarian and maintained by the creator of Pastel. Powered by Pastel (soon).
146146

147147
## Todo
148-
- Custom favicon support
148+
- Custom favicon support

0 commit comments

Comments
 (0)