🤝 Contribuindo para os Documentos

Olá Dyno! Olá Markdown!

This docs is made on Docusaurus platform and written in Markdown! Please feel free to suggest changes and edit the pages on GitHub, this help is really important to us and we really appreciate those who help writing it!

Suggesting Changes

You can suggest changes directly on GitHub by pressing Edit this Page button at the bottom left of each Page, just make a suggestion and open a Pull Request with it! Once accepted, your suggestion will immediately apply on the bleeding-edge version of the docs!

Running the Docs Locally

To preview your changes before opening a Pull Request, clone the docs repository with its submodules (the API is a submodule) and run it with Node.js and Yarn:

Terminal

git clone --recurse-submodules https://github.com/nanos-world/docs.git
cd docs
yarn install
yarn start

The docs will open at http://localhost:3000 and reload as you edit the files.

Where to Edit

• docs/ is the bleeding-edge version of the docs, which matches the latest game updates. Most changes should be made here.
• versioned_docs/version-latest/ is the stable version. Only edit it to fix something that is also wrong in the current stable game version.
• blog/ contains the news posts.
• src/api/ is a submodule with the API JSON files (see below).

Writing Tips

• Every heading ends with an explicit anchor, like ## My Heading {/* #my-heading */}, so links keep working in translated pages. Run yarn write-heading-ids to generate them.
• Link to other pages using their file path, e.g. [Packages Guide](/core-concepts/packages/packages-guide.mdx).
• Use the built-in components to reference the API, such as <Classes.Character />, <StaticClasses.Server />, <MethodReference type="Class" class_name="Actor" method_name="SetLocation" /> and <EventReference type="Class" class_name="Character" event="Death" />.
• Add the side in the title of Lua code blocks (e.g. ```lua title="Server/Index.lua"), it helps readers to know where the code runs.

API Reference

Our Docs is smart! The Scripting Reference section is auto generated based in our JSON API Repository on GitHub. We have defined all Classes, methods and events as JSON which can be parsed to any format!

So if you want to suggest a change to any description or typo you found there, refer to our API Repository folders: Classes, StaticClasses, Structs, UtilityClasses, StandardLibraries or Enums!

Translated Pages

Por padrão, todas as páginas no GitHub estão em inglês e toda a tradução é fornecida pelo Crowdin. You can access the nanos world official docs Crowdin page and help us fulfilling the translation for all available languages! Mais idiomas podem ser solicitados! Por favor, deixe-nos saber se você quer ajudar com um novo idioma!