/fullcalendar-site-static

Static content for fullcalendar.io

Primary LanguageHTML

FullCalendar Website Static Content Build Status

This repo contains the static content for fullcalendar.io.

The source for documentation articles are found in directories like _docs-*.

Reporting Problems

See a problem with the docs? Create a ticket in the main dev repo's issue tracker. All docs-related bugs have the docs label.

Contributing

To make edits to the documentation please submit a Pull Request against the master branch of this repo.

Getting Set Up

First, clone this repo.

Then, install Jekyll (a static-site generator) on your local machine. You can view in-depth instructions, but essentially you need to have ruby available on your machine and then you can run:

gem install jekyll

You also need to have the Rubygem bundler installed:

gem install bundler

Then, cd into the fullcalendar-site-static directory you cloned.

Then, run the following:

npm install
npm run watch

A url will pop up, probably http://127.0.0.1:4000, which you can then view in a browser. If you used the --watch parameter, the built site will rebuild with every edit. If you want a speedier build, use the --incremental parameter, but be aware of its shortcoming.

Linting

Please make sure linting passes before submitting PRs. Run:

npm run lint