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: 1a52f711b0
Grenar Taggar
godot-docs
ZIP TAR.GZ
Matthew 1a52f711b0 Merge pull request #9721 from backlands/patch-2 1 år sedan
.github dbb13eb5a9 Clarify where to report engine bugs 1 år sedan
_extensions 0a01baec10 Fix epub-related failures (#8207) 1 år sedan
_static 57c24d9b46 Fix scrolling outside of content area 1 år sedan
_styleguides 88970e5daa Add German style guide 1 år sedan
_templates bedd304160 Remove Giscus from search page (#8777) 1 år sedan
_tools 799f39d4b6 Fix redirect to new contribution guidelines 1 år sedan
about 19ffef34f8 Update Docs for ARM support 1 år sedan
classes 12846af678 classref: Sync with current master branch (3978628) 1 år sedan
community b08d7fea84 First look at editor's interface iteration 1 år sedan
contributing e69daec15f Fix funding link to be an external link 1 år sedan
getting_started cdf9895ec9 Add instructions for opening a scene in Creating instances (#9143) 1 år sedan
img 1586144704 Improve color constants cheat sheet (#8569) 1 år sedan
tutorials 9017929096 Add links to navigation mesh chunks demos 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 923fbf2bb6 Update ReadMe file with offline doc options 1 år sedan
conf.py 3e3bbde35b Add support for embedding videos in documentation pages 1 år sedan
index.rst 86192a2830 Merge pull request #9609 from MurderVeggie/how-to-contribute 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 (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.