diff --git a/README.md b/README.md index aaba2fa1..4ca85dc3 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,52 @@ -# Website +
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +# Figura Wiki -### Installation +[View the Wiki](https://wiki.figuramc.org/) + +
-``` -$ yarn -``` +## About -### Local Development +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. + +## Getting Started + +### Prerequisites -``` -$ yarn start -``` +Before you start, ensure you have the following installed: -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +- [Git](https://git-scm.com/downloads) +- [Node.js](https://nodejs.org/en/download/) +- [pnpm](https://pnpm.io/installation) + +### Local Development -### Build +To set up the wiki for local development: -``` -$ yarn build -``` +1. **Install [Prerequisites](#prerequisites)**: Ensure you have Git, Node.js, and pnpm installed on your machine. +2. **Clone the Repository**: Run `git clone https://github.com/FiguraMC/wiki.git` to clone the repository. +3. **Navigate to the Project Directory**: Use `cd wiki` to enter the project directory. +4. **Install Dependencies**: Execute `pnpm install` or `pnpm i` to install necessary dependencies. +5. **Start the Development Server**: Run `pnpm start` to launch the local development server and view changes in real-time. -This command generates static content into the `build` directory and can be served using any static contents hosting service. +### Contributing -### Deployment +To contribute to the Figura Wiki: -Using SSH: +1. **Fork the Repository**: [Fork](https://github.com/figuraMC/wiki/fork) this repo and clone it using `git clone https://github.com//wiki`. +2. **Create a New Branch**: Use `git checkout -b your-cool-branch` to create and switch to a new branch for your changes. +3. **Make and Preview Changes**: Edit files and preview changes locally by following the [Local Development](#local-development) instructions (starting from step 3). +4. **Format Your Code**: Run `pnpm format` to 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. +5. **Build the Website**: Use `pnpm build` to generate the static site and check for broken links or other issues. +6. **Commit and Push Changes**: Commit your changes and push them to your forked repository. +7. **Create a Pull Request**: Open a pull request to merge your changes into the `main` branch of the original repository. -``` -$ USE_SSH=true yarn deploy -``` +## Additional Resources -Not using SSH: +- [Docusaurus](https://docusaurus.io/) - This website was built using docusaurus. Checkout their docs for help with making changes to our wiki. +- [Figura](https://github.com/FiguraMC/Figura) - The Figura source code -``` -$ GIT_USER= yarn deploy -``` +## Contact -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +For questions or assistance, reach out to the maintainers on [Discord](https://discord.gg/figuramc).