The Figura Wiki serves as a comprehensive resource for the Figura mod in Minecraft. It offers detailed guides, documentation, and information to help users and contributors effectively engage with and utilize the Figura mod.
Before you start, ensure you have the following installed:
To set up the wiki for local development:
- Install Prerequisites: Ensure you have Git, Node.js, and pnpm installed on your machine.
- Clone the Repository: Run
git clone https://github.com/FiguraMC/wiki.gitto clone the repository. - Navigate to the Project Directory: Use
cd wikito enter the project directory. - Install Dependencies: Execute
pnpm installorpnpm ito install necessary dependencies. - Start the Development Server: Run
pnpm startto launch the local development server and view changes in real-time.
To contribute to the Figura Wiki:
- Fork the Repository: Fork this repo and clone it using
git clone https://github.com/<YOUR-USERNAME>/wiki. - Create a New Branch: Use
git checkout -b your-cool-branchto create and switch to a new branch for your changes. - Make and Preview Changes: Edit files and preview changes locally by following the Local Development instructions (starting from step 3).
- Format Your Code: Run
pnpm formatto ensure your code follows the project's formatting rules. It's a good practice to commit your changes before formatting so you can easily review changes the formatter made. - Build the Website: Use
pnpm buildto generate the static site and check for broken links or other issues. - Commit and Push Changes: Commit your changes and push them to your forked repository.
- Create a Pull Request: Open a pull request to merge your changes into the
mainbranch of the original repository.
- Docusaurus - This website was built using docusaurus. Checkout their docs for help with making changes to our wiki.
- Figura - The Figura source code
For questions or assistance, reach out to the maintainers on Discord.