Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CI for gh pages #767

Merged
merged 7 commits into from
Dec 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
37 changes: 37 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Build and Deploy

on:
push:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '20'

- name: Install generate-docs dependencies
run: cd generate-docs; ./install-dependencies.sh

- name: Run generate-docs
run: cd generate-docs; ./build-docs.sh

- name: Install website dependencies
run: cd website; npm install

- name: Build website
run: cd website; npm run build

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./website/build
18 changes: 9 additions & 9 deletions docs/what-and-why.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,6 @@ Notably versatile, Reason serves as an excellent choice for a range of applicati

## Why Use Reason?

<iframe
width="784"
height="432"
src="https://www.youtube.com/embed/5fG_lyNuEAw?si=HPFaMIMIX0Krn2wK"
title="Jordan Walke - Keynote ReasonConf US 2019"
frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen>
</iframe>

**Functional Programming**

Reason is a practical functional programming language. Offers a powerful blend of functional programming capabilities, with optional support for mutation and side-effects, enhancing its practicality.
Expand All @@ -45,6 +36,15 @@ JSX is part of the language. JSX is an embeddable XML-like syntax, used to descr

Reason can be compiled to native, bytecode, and JavaScript, with an ongoing plan for WebAssembly.

<iframe
width="784"
height="432"
src="https://www.youtube.com/embed/5fG_lyNuEAw?si=HPFaMIMIX0Krn2wK"
title="Jordan Walke - Keynote ReasonConf US 2019"
frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen>
</iframe>

## Different Environments

Reason compiles to JavaScript thanks to our partner project, [Melange](compiling-to-js-with-melange.md), which compiles OCaml/Reason into JavaScript with smooth interoperability with JavaScript. Reason also compiles to fast, barebone assembly, thanks to OCaml itself.
Expand Down
2 changes: 1 addition & 1 deletion generate-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ How to generate Reason API docs from OCaml

```bash
./install-dependencies.sh
./build-docs.sh
./build-docs.sh
```

Converted HTML is now in `output/`
2 changes: 1 addition & 1 deletion generate-docs/build-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ docs_path="../website/pages/api/"

mkdir -p ./output/
rm -f ./output/*.html
cp ocaml/ocamldoc/stdlib_html/*.html ./output/
cp ocaml/api_docgen/ocamldoc/build/html/libref/*.html ./output/
echo ""
echo "converting docs - this will take a minute"
echo ""
Expand Down
2 changes: 1 addition & 1 deletion generate-docs/install-dependencies.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ if [[ ! -d "ocaml/" ]]; then
fi
cd ocaml/

git checkout 4.02.3
git checkout 5.0
./configure
make clean
make world
Expand Down
Loading
Loading