Giter VIP home page Giter VIP logo

v0.x'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.

v0.x'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 rahulcs avatar rgieseke avatar rich-harris avatar rstacruz avatar scott-dickson avatar sigod avatar silentworks avatar svbatalov avatar tombyrer avatar valeriangalliat avatar xavierboubert avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

v0.x's Issues

manual changes to merge

page#hash links don't work

On the GitHub wiki, it was possible to link to sections of a page by appending a hash - the relevant anchors were auto-generated. That's no longer the case

`adapt` versus `adaptors`

There's a registry of adaptors. But then you have to opt-in to using the adaptor with adapt?

Maybe because adaptors are highly invasive in that everything gets run through them?

None of the other registries works that way...

Internals of Ractive

I read through all of the Ember.js Docs and liked how at the end there was in the in depth dive that explained all the internals. Would be cool to document the various portions of Ractive. The parser, renderer, the run loop, maybe a few other things.

Pages with out of date or incomplete info

...or which need a bit of a general tidy up:

  • Ractive.events
  • Plugins
  • Events
  • API Reference
  • Preparsing
  • Ractive.toHTML()
  • Using Ractive with Backbone

Also, some methods don't have documentation yet e.g. ractive.findComponent() and ractive.findAllComponents()

content partial for components not documented

Realized as of #583 on ractive repo that this isn't documented in partials.
Components need some love, maybe a simpler example to start and then the more in depth example that is currently there.

New Look?

Are you opposed to the docs potentially having a completely new look. Things seem very dispersed all over. Was thinking about making an API section that would dive into all the functions for everything, much like the API.reference you have now. Then splitting it off into getting started/docs/concept stuff etc.This would all have some sort of left side based nav.

Orphaned doc pages

Lots of pages currently seem to be orphaned - as in, they can be visited, but nothing links to them. Examples include the "Tips" page and most of the "Using Ractive.js with..." pages.

Link Tips page

Link the Tips page in the main nav, probably Introduction. Make sure linked pages are up-to-date.

Inline Examples

Still thinking about how to implement this, concept isn't hard but would like a consistent theme throughout the site. So probably going to pull code/style from examples page and run with that.

Edge doc's preview available online

So, I added a way to preview edge docs online. Basically I set up an edge alias that points to 0.4.1 docs and templates.

Don't make edits in the 0.4.1 folders of master!. Edits happen in the 0.4.0 folders of the dev branch. Reason being that we can merge in master changes that happen in 0.4.0.

The process is to periodically make a copy of the 0.4.0 from the dev branch (I added a gitignored copy folder), switch to the master branch and copy that folder to 0.4.1 then push to github. Not exciting, but best I could come up with.

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.