Code Monkey home page Code Monkey logo

documentation's Introduction

ETJump Documentation

ETJump is a Wolfenstein: Enemy Territory trickjump modification. ETJump documentation contains set of all avaible ETJump cvars, mapping entities and more. This documentation is hosted on the http://etjump.rtfd.io/.

How to contribute

This documentation is build using mkdocs. This allows us to use markdown for all documentation pages, easing the use and editing process. If you would like to edit or add ETJump documentation, you have two options to follow:

  • Edit documentation directly on github
  • Edit documentation locally on your machine

Both steps requires to have github account.

Edit documentation directly on github

To edit documentation you would need to open required file and then press edit button on it, you can then edit the file and propose changes afterwards.

Edit documentation locally on your machine

To edit documentation locally you would need to:

  • install mkdocs
  • clone this repository
  • run mkdocs serve command in terminal within the cloned repository
  • edit/add documentation

After editing files, commit and push changes using git, then do Pull Request to this repository. After reviewing, your changes will be applied to this documentation.

Adding new pages

Adding/deleting pages in documentation should also be followed with mkdocs.yml file editing, which contains the documentation page structure.

documentation's People

Contributors

aciz avatar haapanen avatar isryven avatar

Stargazers

 avatar

Watchers

 avatar  avatar  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.