https://github.com/usethesource/rascal-website
The rascal website hosts the Rascal project, all of its documentation, the news and the presentation of (third-party) libraries and projects written in Rascal.
https://github.com/usethesource/rascal-website
Last synced: about 1 year ago
JSON representation
The rascal website hosts the Rascal project, all of its documentation, the news and the presentation of (third-party) libraries and projects written in Rascal.
- Host: GitHub
- URL: https://github.com/usethesource/rascal-website
- Owner: usethesource
- Created: 2013-07-06T19:44:11.000Z (almost 13 years ago)
- Default Branch: website-v2
- Last Pushed: 2024-10-18T12:06:54.000Z (over 1 year ago)
- Last Synced: 2024-10-19T12:23:53.323Z (over 1 year ago)
- Language: Rascal
- Homepage:
- Size: 133 MB
- Stars: 1
- Watchers: 22
- Forks: 11
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator and [Rascal Tutor](https://github.com/usethesource/rascal-tutor) a documentation generator for Rascal source files and a MarkDown pre-processor for executing inline code fragments, cross linking between courses and screenshotting interactive visualizations.
### Installation
You need NodeJS 14+ installed, and yarn (`npm install --global yarn`)
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
This will generate the docs and download docs from projects we depend on, running rascal-tutor:
```
mvn package -Dwebdriver.chrome.driver=/path/to/geckodriver -Dwebdriver.chrome.browser=/path/to/google\ chrome
```
Without the webdriver parameters no screenshots will be taken from `Content` output in `rascal-shell` examples.
This will then compile the generated/downloaded markdown files to html:
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service, but this will typically start a server for you to test the result:
```
$yarn serve
```
### Deployment
The `main` branch is automatically deployed immediately after `git push` to the github origin.