Startsida Utforska Hjälp
Logga in
Godot
/
godot-docs
spegling av https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Filer Ärenden 0 Wiki

#godot #docs #howto

Träd: 13d4bce74b
Grenar Taggar
godot-docs
ZIP TAR.GZ
Matthew 13d4bce74b Merge pull request #9436 from Bamarin/patch-2 1 år sedan
.github b08b23d19b Build offline version of stable branch 1 år sedan
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 år sedan
_static 183d0e3147 Fix css background color override for highlight box (#9314) 1 år sedan
_styleguides 88970e5daa Add German style guide 1 år sedan
_templates bedd304160 Remove Giscus from search page (#8777) 1 år sedan
_tools 535915b228 Add `thirdparty` as linter exception 1 år sedan
about 644552ddd2 Release policy: Bump 4.3 ETA to June 1 år sedan
classes f95c1a2b4e classref: Sync with current master branch (b7feebe) 1 år sedan
community 8520601b13 Update the community channels 1 år sedan
contributing b702b8794a Fix typo 1 år sedan
getting_started 8853a6af08 updated image reference 1 år sedan
img c9a72d06e8 Update Tween cheatsheet to add TRANS_SPRING (#7464) 2 år sedan
tutorials d884e3ef07 Correction on usage of Dictionaries in C# as it should be 'Godot.Collections.Dictionary<>' 1 år sedan
.editorconfig 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 år sedan
.gitattributes 24d0a7ec39 Add `.editorconfig` and `.gitattributes` files for automatic settings (#4700) 4 år sedan
.gitignore 47bacc95fd Added configuring ide for rider (#7420) 2 år sedan
.mailmap 8e9d2ba633 Add AUTHORS.md with list of main contributors 5 år sedan
.readthedocs.yml d9e0d8386e Add tools definition for RTD 2 år sedan
AUTHORS.md 5175fb8256 Use official CC BY 3.0 terminology and resources 3 år sedan
LICENSE.txt 9bfc111547 Add full text of CC-BY-3.0 license 6 år sedan
Makefile 31204023b6 Makefile: use sphinx-build -M 2 år sedan
README.md dbe3a88377 Fix various minor typos 1 år sedan
conf.py 3e3bbde35b Add support for embedding videos in documentation pages 1 år sedan
index.rst c5c215a179 Added separate links to stable/latest/3.6 copies of the offline documentation 1 år sedan
make.bat 64a3b465c2 Update SFC to Godot Foundation, old URLs 2 år sedan
requirements.txt 3e3bbde35b Add support for embedding videos in documentation pages 1 år sedan
robots.txt fd5f6f4909 Appease our great search engine overlords 5 å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 for offline reading (updated every Monday). 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 for offline reading (updated every Monday). 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.