https://github.com/boazsegev/plezi-website

The public Plezi.io website, with it's docs and tutorials
https://github.com/boazsegev/plezi-website

Last synced: 6 months ago
JSON representation

The public Plezi.io website, with it's docs and tutorials

• Host: GitHub
• URL: https://github.com/boazsegev/plezi-website
• Owner: boazsegev
• Created: 2015-11-09T04:01:18.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-01T04:45:14.000Z (over 2 years ago)
• Last Synced: 2023-03-17T21:35:19.286Z (about 2 years ago)
• Language: JavaScript
• Homepage: www.plezi.io
• Size: 3.08 MB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Contributing to the Website / Documentation

Thank you for your interest in contributing to the facil.io website and documentation.

NOTICE: `_SOURCE` is the folder that contains the actual documentation files. Edits to the documentation should be placed in this folder.

Anything outside the `_SOURCE` folder (including this file) is created automatically by the `server` script and shouldn't be edited.

If you want to contribute to the documentation, please do so by opening a Pull Request (PR) with updates to the files in the `_SOURCE` folder.

## Running the website locally

It's possible to run a local version of the website using Ruby (make sure to have Ruby and Ruby gems available on your system).

Open the terminal window and go to the `_SOURCE` folder. Than run (currently runs on macOS and Linux):

    $ bundle install

    $ ./server