Skip to content

A detailed collaborative Trackmania API documentation.

License

Notifications You must be signed in to change notification settings

AtomicLiquid/nadeoapi-docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Trackmania API documentation

Tests

Visit the documentation here.

Running the documentation locally

Docker is the recommended way of developing the site, and also for testing documentation changes locally.

  1. Build the docker image:
    docker build -t op-nadeoapi-docs .
    
  2. Start a container:
    docker run --rm -v $(pwd):/var/www/html -p 80:80 op-nadeoapi-docs
    
  3. Visit http://127.0.0.1/

Running tests

Content tests run automatically on a push to the repository. To run them locally, you need Python and PyYAML. Then, simply run the test script:

$ ./test.py

About

A detailed collaborative Trackmania API documentation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 95.4%
  • Python 3.7%
  • Other 0.9%