Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
Godot
/
godot-docs
zrkadlo https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Súbory Issues 0 Wiki

#godot #docs #howto

Strom: 5eebe5f1fa
Branche Tagy
godot-docs
ZIP TAR.GZ
tetrapod 5eebe5f1fa Merge pull request #10419 from tetrapod00/manifold-define 7 mesiacov pred
.github b3baf825f1 Remove default labels from issue templates 7 mesiacov pred
_extensions b646c65bed Update GDScript syntax highlighter 9 mesiacov pred
_static 0da4dbe145 Add self links to shader functions page 7 mesiacov pred
_styleguides 88970e5daa Add German style guide 1 rok pred
_templates f47af1fb9e Only show warning box if page is outdated 7 mesiacov pred
_tools f70686cdbe CI: Integrate `pre-commit` for style checks 8 mesiacov pred
about 6d5fd9acc8 Merge pull request #10427 from raulsntos/dotnet/changes-in-4.4 7 mesiacov pred
classes f01f0df6c0 Remove trailing double quote from link in GLTFState documentation 7 mesiacov pred
community 9bcc7524bc Remove link to Reddit list of tutorials 8 mesiacov pred
contributing 1e6f52a566 Merge pull request #10423 from tetrapod00/tweak-class-ref 7 mesiacov pred
getting_started 6d5fd9acc8 Merge pull request #10427 from raulsntos/dotnet/changes-in-4.4 7 mesiacov pred
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 11 mesiacov pred
tutorials 5eebe5f1fa Merge pull request #10419 from tetrapod00/manifold-define 7 mesiacov pred
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 rokov pred
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 rokov pred
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 mesiacov pred
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 8 mesiacov pred
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 rokov pred
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 11 mesiacov pred
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 rokov pred
Makefile 31204023b6 Makefile: use sphinx-build -M 2 rokov pred
README.md d4b2a69cf6 Fix broken link in README to Contributing section 9 mesiacov pred
conf.py 2cbe8488d4 Update broken link to RTD docs in comment 8 mesiacov pred
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 1 rok pred
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 rokov pred
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 8 mesiacov pred
requirements.txt 436b6e1793 Bump sphinx-rtd-theme from 3.0.1 to 3.0.2 8 mesiacov pred
robots.txt fd5f6f4909 Appease our great search engine overlords 5 rokov pred

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.