{"repo":"FlaxEngine/FlaxDocs","free":true,"listed":false,"github":"https://github.com/FlaxEngine/FlaxDocs","clone":"git clone https://github.com/FlaxEngine/FlaxDocs.git","description":"Flax Engine Documentation","language":"C#","stars":122,"topics":["flax-documentation","gamedev","flax","flax-engine","game-engine","documentation","docs","docfx","flaxengine"],"license":"CC-BY-4.0","category":"game-templates","readme_excerpt":"Flax Engine Documentation Welcome to the Flax documentation repository. This repository contains all the source files for the Flax documentation (https://docs.flaxengine.com/). Anyone is welcome to contribute! Editing We use DocFX tool for building and hosting documentation online. It supports markdown style files ( .md ) as it's a very standardized and popular format. Writing technical documentation using markdown style is easy and efficient. To edit docs we recommend you to use tools such as Zettlr or Typora or Visual Studio Code. Building and Testing Documentation can be built and hosted on both Linux and Windows. DocFx can run on .Net or Mono. By default the site is hosted on localhost:8080 but this can be easily configured. Windows Download repository (or clone with git clone https://github.com/FlaxEngine/FlaxDocs.git ) Call build manual.bat to build the Manual or build all.bat to build whole documentation (with API) but it will take more time to finish Call run local website.bat to preview the site Linux Install Mono Clone repository ( git clone https://github.com/FlaxEngine/FlaxDocs.git ) Call chmod +x docs.sh . It will modify permissions for the script docs.sh to allow to execute it Call ./docs.sh rebuild Technical Notes C# and C++ API reference pages are generated by downloading and building engine at a given revision specified in file commit.txt . C# API is extracted via docfx metadata into api folder. C++ API is extracted via our custom fork of code2yaml which pars","default_branch":null,"files":null,"tree":[],"storefront":"/r/FlaxEngine","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/FlaxEngine/FlaxDocs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}