You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 23, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Pastel is a PHP tool to generate beautiful documentation from Markdown. [Here's
8
8
<imgsrc="./screenshots/pastel-screenshot-1.png">
9
9
</p>
10
10
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.
12
12
13
13
## Table of contents
14
14
-[Installation](#installation)
@@ -20,7 +20,7 @@ This project is a fork of [Documentarian](https://github.com/knuckleswtf/pastel)
20
20
21
21
## Installation
22
22
```bash
23
-
composer require knuckleswtf/pastel
23
+
composer require --dev knuckleswtf/pastel
24
24
```
25
25
26
26
## Usage
@@ -30,9 +30,9 @@ Pastel is like Documentarian and Slate, but simpler and with a somewhat differen
30
30
Start off with a single Markdown file. There are two parts:
31
31
32
32
#### 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.
34
34
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)).
36
36
37
37
For a full explanation of the supported Markdown syntax, see [How to Edit Slate Markdown files](https://github.com/slatedocs/slate/wiki/Markdown-Syntax)
38
38
@@ -145,4 +145,4 @@ You can help your lower-level headings stand out by using the `fancy-heading-pan
145
145
-[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).
0 commit comments