Giter Site home page Giter Site logo

karma-runner.github.com's Introduction

karma-runner.github.com

js-standard-style devDependency Status

This is the source code for http://karma-runner.github.com. The homepage and documentation of karma, the spectacular test runner.

If you wanna update the docs, just go the the main repo and update the markdown. You can even do that directly from the github web interface.

Building the Documentation

$ git clone https://github.com/karma-runner/karma-runner.github.com.git
$ cd karma-runner.github.com
$ npm install
$ grunt

Now open your browser at http://localhost:8000.

Maintenance

Add or update documentation content for docs-version based on the content of Karma repository at branch-or-tag-in-karma-repo revision:

$ ./sync-docs.sh <branch-or-tag-in-karma-repo> <docs-version>

Examples:

  • Generate documentation for Karma 5.0 based on the v5.0.4 tag in the Karma repository:

       $ ./sync-docs.sh v5.0.4 5.0
  • Generate documentation for Karma 5.1 based on the latest master branch in the Karma repository:

    $ ./sync-docs.sh master 5.1

karma-runner.github.com's People

Contributors

ameerthehacker avatar anshbansal avatar btford avatar caiotoon avatar dependabot[bot] avatar devoto13 avatar dignifiedquire avatar diogoosorio avatar elumalai avatar gsuresh86 avatar isyiwang avatar jackdalton avatar jakub-g avatar jfroom avatar johnjbarton avatar maksimr avatar matsko avatar omgimalexis avatar peterpan666 avatar pkozlowski-opensource avatar raineorshine avatar semantic-release-bot avatar shane99a avatar srawlins avatar t3chnoboy avatar timbru31 avatar tschaub avatar vivganes avatar vojtajina avatar wesleycho 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

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

karma-runner.github.com's Issues

Documentation versioning is not obvious

I'm new to Karma and somehow ended up on documentation for version 0.8, and after installing with npm install -g karma, was very confused as to why I couldn't get Karma to work on the command line. Documentation for 0.12 includes information about karma-cli, but it took me a long while to realize I was on the wrong version.

Some sort of much more obvious banner or sign on older versions of the documentation should exist to alleviate the confusion.

Add "latest" (generic) URLs for individual pages

In NetBeans, we support Karma (you know that ;) and we would like to point users to Karma installation page. However, the URL currently contains Karma version [1] which is unfortunate since sooner or later, the page will be out-of-date. Could you please add generic URLs for the latest stable version, something like [2] or [3]?

Thanks for understanding,
Tomáš
[1] http://karma-runner.github.io/0.12/intro/installation.html
[2] http://karma-runner.github.io/latest/intro/installation.html
[3] http://karma-runner.github.io/stable/intro/installation.html

Linking to the correct place on GitHub

Currently, Configuration file links to https://github.com/karma-runner/karma/blob/master/test/client/karma.conf.js. This is problematic as this is not the 0.8 syntax, but the syntax in 0.9. It's really important that the docs are easy to understand and use for new users. New users shouldn't fail when setting up Karma because they are following the wrong docs.

I was going to create a pull request using the stable branch, but the problem is that that's only a solution until 0.10, when the 0.8 docs again will be wrong. Do you have any ideas about how this can be handled?

Rewrite links

So that markdown can refernce *.md files rather then *.html files. (and therefore links for on github too).

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.