Skip to content

Commit

Permalink
Optimize readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chemaclass committed Aug 26, 2023
1 parent 37fa1a0 commit c2cd219
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,33 @@

This is the code for the website of Phel: https://phel-lang.org.

## Build the documentation
## How to

1. Build the API page
2. Build the documentation

### Build the API page

```bash
# install phel as a composer dependency
composer install

# build the API doc page & the API search index
composer build
```

### Build the documentation

The documentation is build with [Zola](https://www.getzola.org/).

#### Local development

```bash
zola serve # build & serve
zola build # build & publish
```

## Build the API page
#### Prod environment

```bash
composer install # install phel as composer dependency
composer build # build the API documentation page & the API search index
```
zola build # build & publish
```

0 comments on commit c2cd219

Please sign in to comment.