karma-runner / karma-runner.github.com Goto Github PK

Homepage of Karma - The Spectacular JavaScript Test Runner.

JavaScript 1.46% CSS 0.02% Shell 0.02% HTML 97.19% Pug 0.10% Less 1.22%

karma-runner.github.com's Introduction

karma-runner.github.com

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

Stargazers

Watchers

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

"There are some special rules at the moment, as we have not yet released a 1.0.0."

The text in the title appears on the Versioning page. It probably needs an update to talk about what versioning is going to look like now karma-runner is v1.x.

Broken link on 'Who uses Karma'

Link in Inftec logo is missing a http:// and redirects to an error page.

Insert anchors into rendered HTML

http://karma-runner.github.io/ includes pages with lots of headings, which is good, but there's no way to link to them directly. The build process should automatically generate "id" attributes, and ideally also show links on hover.

Create page for third party plugins

Ref karma-runner/karma#564

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?

Are you interested in a pull request on an updated documentation?