Temporary branch being used to rewrite ReactPy's documentation.
Many of these pages are in progress, and are using the original ReactJS docs as placeholders.
See live preview here: https://reactive-python.github.io/reactpy
In order to set up an environment to develop these docs...
- Install Python 3.9 or higher
- Fork and clone this repository
- Optional: Create a Python virtual environment with the following command:
python3 -m venv venv
- Optional: Activate the virtual environment (this method will vary based on operating system)
- Install the dependencies with the following command:
pip install -r docs/requirements.txt
- Run the following command:
mkdocs serve
- Follow the on-screen prompts to view the documentation in your browser
- You can now edit the markdown files located within
docs/src/
and see the changes in real time
🚧 : Unfinished tab 🚫 : Tab is blocked from being started due to external factors
Feel free to PR this branch with any changes you make to the documentation. If you have any questions, feel free to ask in the Discord server.