farjs / farjs.github.io

Web site repo for FAR.js

FAR.js GitHub Pages

Jekyll Theme

The site is built using the jekyll-theme-slate theme.

Previewing the site locally

If you'd like to preview the site locally (for example, in the process of proposing a change):

1. Clone down the site's repository (git clone https://github.com/farjs/farjs.github.io)
2. cd into the site's directory
3. Run ./script/bootstrap.sh to install the necessary dependencies
4. Run ./script/server.sh to start the preview server
5. Visit localhost:4000 in your browser to preview the site

Running tests

The site contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run ./script/cibuild.sh. You'll need to run ./script/bootstrap.sh one before the test script will work.

Markdown

Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for

Syntax highlighted code block

# Header 1
## Header 2
### Header 3

- Bulleted
- List

1. Numbered
2. List

**Bold** and _Italic_ and `Code` text

[Link](url) and ![Image](src)

For more details see GitHub Flavored Markdown.

How to embed draw.io Diagrams

GitHub support is now available https://www.draw.io/?mode=github

An example for integration into GitHub wikis is available here Embed Diagrams

Example diagrams are available here