Skip to content

README.md

Latest commit

 

History

History
53 lines (33 loc) · 1.57 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.57 KB

Build

Development Metin2Dev Wiki

A metin2 related Wiki with information about official content and topics

This repository is just for development and beta preview of content, for stabilized content check the stable repository

Developing

Setup

  • Install Python 3.10
  • Clone this repository by typing git clone https://github.com/Metin2-Dev/wiki-beta-dev
  • Install Poetry on your machine
  • Install dependencies by typing poetry install
  • Spawn a shell by typing poetry shell and you are good to go

Building locally

  • Build by typing poe build-docs
  • Or by doing cd docs/ and typing make html
  • Whenever you need to clean type make clean

Note: If you don't have make on Windows, you can use make.bat instead

Previewing

To preview locally on the browser after building do make open or open the html in _build/html/index.html

Contributing

If you wish to contribute to the project, be sure to read the Contributing Guidelines