Welcome to the Fiesta Heroes documentation repository! This repository contains the documentation for Fiesta Heroes. A live version of the documentation can be found at https://doc.fiestaheroes.com.
To start local development and contribute to the documentation, follow these steps:
-
Clone the repository to your local machine:
git clone https://github.com/your-username/fiesta-heroes.git
-
Navigate to the repository and install the dependencies:
cd fiesta-heroes npm install -
Start the local development server:
npm run start
-
The documentation site should now be running locally at http://localhost:3000.
If you would like to contribute to the documentation, please open a pull request with your changes. If you are unsure about something, feel free to open an issue to discuss it.
To add a new page to the documentation, follow these steps:
-
Create a new markdown file in the
docsdirectory. The file name will be the URL path of the page. For example,docs/new-page.mdwill be available at/new-page. -
Add the following frontmatter to the top of the file:
--- title: New Page sidebar_position: 0 # Position of the page in the sidebar. ---
-
Add the content for the page below the frontmatter.
-
Commit your changes and open a pull request.
If you need to make changes to anything related to Lua, please modify the fiesta.lua file located in the static/files directory. The fiesta.lua file is auto-generated by a script located at scripts/convert_lua.py.
To generate the Markdown page from the Lua script, follow these steps:
-
Make sure you have Python 3 installed on your machine.
-
Run the following command:
cd scripts python convert_lua.py -
The fiesta.lua file will be converted to Markdown and placed in the docs/lua directory.
This project is licensed under the MIT License.
The Fiesta herores documentation (e.g., .md files in the /docs folder) is BSD Zero Clause License.