Giter VIP home page Giter VIP logo

docs.ractivejs.org's Introduction

docs.ractivejs.org

The documentation for Ractive.js.

Building

# clone the repo
$ git clone https://github.com/RactiveJS/docs.ractivejs.org.git
$ cd docs.ractivejs.org

# install dev dependencies (grunt and friends)
$ npm install

# start building
$ grunt

Running grunt will build the site and rebuild when docs changes. You need to use a local webserver to preview in your web browser. One easy option is to use http-server (installable via npm install -g http-server). You need to run it from the /build directory and explicitly include html as the default extension (add -s for silent mode):

docs.ractive.org/build>http-server -e html

Open localhost on the port specified (usually 8080), and it should redirect to localhost:8080/latest/get-started. Refresh to pick up changes made in docs.

Contributing

If you see something wrong, out of date, or missing from this documentation, please raise an issue on GitHub or - even better - submit a pull request. Your fellow Ractive users will thank you!

In lieu of formal contribution guidelines, take care to follow the existing structure and conventions. Send pull requests to the master branch, not gh-pages (which is a snapshot of the build folder in master).

Questions?

Contact @RactiveJS on Twitter.

docs.ractivejs.org's People

Contributors

arxpoetica avatar brakmic avatar bryansray avatar codler avatar dagnelies avatar eik3 avatar elliotchong avatar emirotin avatar evs-chris avatar fskreuz avatar giovannipiller avatar iotaweb avatar jondum avatar jonvuri avatar kahwee avatar madgvox avatar martinkolarik avatar martypdx avatar mikemaccana avatar premasagar avatar rahulcs avatar rgieseke avatar rich-harris avatar rstacruz avatar scott-dickson avatar sigod avatar silentworks avatar svbatalov avatar tombyrer avatar xavierboubert avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.