صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
godotengine
/
godot-docs
mirrorاز https://github.com/godotengine/godot-docs
دنبال کردن 1
ستاره دار 1
انشعاب 0
پرونده‌ها

Official EU-hosted mirror of the Godot Engine GitHub documentation repository, provided as backup and for anyone who cannot access GitHub due to US trade restrictions. Please only use the issue tracker if you are restricted from using GitHub.

درخت: f9c0fa58c0
شاخه‌ها تگ‌ها
godot-docs
ZIP TAR.GZ
Marek S. Łukasiewicz f9c0fa58c0 Add a command snippet to build only modified documentation (#10571) 1 هفته پیش
.github 2d30a6940c Merge pull request #10583 from mhilbrunner/gh-2404-imagemagick 1 هفته پیش
_extensions d610bfdf23 GDScript: Document `@warning_ignore_start` and `@warning_ignore_restore` 1 ماه پیش
_static 0da4dbe145 Add self links to shader functions page 1 ماه پیش
_styleguides 88970e5daa Add German style guide 1 سال پیش
_templates f6879c1bc4 Add navigation buttons before user-submitted comments on all pages. 1 ماه پیش
_tools f70686cdbe CI: Integrate `pre-commit` for style checks 2 ماه پیش
about c4d3aa134a Standardize RST header syntax 1 ماه پیش
classes 1c1e1c11bb classref: Sync with current master branch (1586c56) 1 هفته پیش
community e7cea212a4 Merge pull request #10459 from tetrapod00/typo-tutorials 1 ماه پیش
contributing f9c0fa58c0 Add a command snippet to build only modified documentation (#10571) 1 هفته پیش
getting_started 5599391e07 Ambiguous description of _process() (#9084) 2 هفته پیش
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 5 ماه پیش
tutorials 01c2c9f127 Merge pull request #10565 from markdibarry/parallax2d-getting-started 1 هفته پیش
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 سال پیش
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 سال پیش
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 1 سال پیش
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 5 ماه پیش
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 2 ماه پیش
.readthedocs.yml d9e0d8386e Add tools definition for RTD 1 سال پیش
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 5 ماه پیش
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 سال پیش
Makefile 31204023b6 Makefile: use sphinx-build -M 1 سال پیش
README.md d4b2a69cf6 Fix broken link in README to Contributing section 3 ماه پیش
conf.py 68d7191b39 Add Plausible 1 هفته پیش
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 6 ماه پیش
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 1 سال پیش
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 2 ماه پیش
requirements.txt 69a142377b Bump pygments from 2.19.0 to 2.19.1 1 ماه پیش
robots.txt fd5f6f4909 Appease our great search engine overlords 4 سال پیش

README.md

Godot Engine documentation

This repository contains the source files of Godot Engine's documentation, in reStructuredText markup language (reST).

They are meant to be parsed with the Sphinx documentation builder to build the HTML documentation on Godot's website.

Download for offline use

To browse the documentation offline, you can download an HTML copy (updated every Monday): stable, latest, 3.6. Extract the ZIP archive then open the top-level index.html in a web browser.

For mobile devices or e-readers, you can also download an ePub copy (updated every Monday): stable, latest, 3.6. Extract the ZIP archive then open the GodotEngine.epub file in an e-book reader application.

Theming

The Godot documentation uses the default sphinx_rtd_theme with many customizations applied on top. It will automatically switch between the light and dark theme depending on your browser/OS' theming preference.

If you use Firefox and wish to use the dark theme regardless of your OS configuration, you can install the Dark Website Forcer add-on.

Contributing

All contributors are welcome to help on the Godot documentation.

To get started, head to the Contributing section of the online manual. There, you will find all the information you need to write and submit changes.

Here are some quick links to the areas you might be interested in:

  1. Contributing to the online manual
  2. Contributing to the class reference
  3. Content guidelines
  4. Writing guidelines
  5. Building the manual
  6. Translating the documentation

License

With the exception of the classes/ folder, all the content of this repository is licensed under the Creative Commons Attribution 3.0 Unported license (CC BY 3.0) and is to be attributed to "Juan Linietsky, Ariel Manzur and the Godot community". See LICENSE.txt for details.

The files in the classes/ folder are derived from Godot's main source repository and are distributed under the MIT license, with the same authors as above.