Startsida Utforska Hjälp
Logga in
godotengine
/
godot-docs
spegling av https://github.com/godotengine/godot-docs
Bevaka 1
Stjärnmärk 1
Fork 0
Filer

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.

Träd: c14d206f9a
Grenar Taggar
godot-docs
ZIP TAR.GZ
Max Hilbrunner c14d206f9a Merge pull request #10325 from bruvzg/renderer_req 1 dag sedan
.github f70686cdbe CI: Integrate `pre-commit` for style checks 1 månad sedan
_extensions b646c65bed Update GDScript syntax highlighter 1 månad sedan
_static 0da4dbe145 Add self links to shader functions page 4 dagar sedan
_styleguides 88970e5daa Add German style guide 1 år sedan
_templates 181206baaa Remove canonical/hreflang tags, let RTD I18N do it 1 månad sedan
_tools f70686cdbe CI: Integrate `pre-commit` for style checks 1 månad sedan
about e5a51fb12d [System requirements] Add information about different requirements for different renderers. 2 dagar sedan
classes cb88777732 classref: Sync with current master branch (dc5f1b7) 4 dagar sedan
community 9bcc7524bc Remove link to Reddit list of tutorials 3 veckor sedan
contributing bd25f5813a Simply remove some words 3 dagar sedan
getting_started 19337ad628 Tweak wording in Creating the player scene 1 vecka sedan
img c476471e48 This PR adds graphs showing the behavior of the smoothstep function with positive, zero, and negative ranges. (#9489) 4 månader sedan
tutorials ca738a538e Merge pull request #10414 from tetrapod00/meshlibrary-clarify 1 dag sedan
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 år sedan
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 3 år sedan
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 1 år sedan
.mailmap 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 4 månader sedan
.pre-commit-config.yaml 20d9f0d9b1 CI: Remove EOF fixer from pre-commit hook 3 veckor sedan
.readthedocs.yml d9e0d8386e Add tools definition for RTD 1 år sedan
AUTHORS.md 4c3c39cc15 Sync AUTHORS.md to add top contributors from past years 4 månader sedan
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 år sedan
Makefile 31204023b6 Makefile: use sphinx-build -M 1 år sedan
README.md d4b2a69cf6 Fix broken link in README to Contributing section 1 månad sedan
conf.py 2cbe8488d4 Update broken link to RTD docs in comment 1 vecka sedan
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 5 månader sedan
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 1 år sedan
pyproject.toml f70686cdbe CI: Integrate `pre-commit` for style checks 1 månad sedan
requirements.txt 436b6e1793 Bump sphinx-rtd-theme from 3.0.1 to 3.0.2 1 månad sedan
robots.txt fd5f6f4909 Appease our great search engine overlords 4 år sedan

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.