https://github.com/jmuozan/arspostfaber-docs
https://github.com/jmuozan/arspostfaber-docs
documentation grasshopper-plugin grasshopper3d rhino3d
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jmuozan/arspostfaber-docs
- Owner: jmuozan
- License: mit
- Created: 2025-05-16T11:33:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-16T13:33:00.000Z (12 months ago)
- Last Synced: 2025-06-16T14:46:27.146Z (12 months ago)
- Topics: documentation, grasshopper-plugin, grasshopper3d, rhino3d
- Homepage: https://jmuozan.github.io/ArsPostFaber-docs/
- Size: 16.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentation for Ars Post Faber Plug-in
The following repository hosts a mkdocs website to document the developement, usage and purpose of the plug-in *Ars Post Faber* for **Grasshopper** in **Rhino 8** developed by [Jorge Muñoz Zanón](https://www.linkedin.com/in/jorgemunozzanon/)
You can check the code of the plug-in [here](https://github.com/jmuozan/ArsPostFaber) and the documentation website [here](https://jmuozan.github.io/ArsPostFaber-docs/)
If you want to contribute (or you already have) to the main code it will be great if you can contribute to this website by making some cool documentation so people can understand how your component works and why you decided to coded (as a plus you can also explain how you made it so other people can understand it and maybe make some iterations)
## How do I contribute to the documentation website?
Essential to have [git](https://git-scm.com/downloads) installed in your computer
### Clone the repository
```bash
git clone https://github.com/jmuozan/ArsPostFaber-docs.git
```
### Move to your directory
```bash
cd your_directory/ArsPostFaber-docs
```
### Create virtual environment
```bash
python -m venv venv
```
### Activate virtual environment
#### MacOS
```bash
source myvenv/bin/activate
```
#### Windows
```bash
# In cmd.exe
venv\Scripts\activate.bat
# In PowerShell
venv\Scripts\Activate.ps1
```
### Install [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
```bash
pip install mkdocs-material
```
### Check changes live while editing
```bash
mkdocs serve
```
### Create a Branch to Work on Your Changes
```bash
git branch BRANCH-NAME
git checkout BRANCH-NAME
```
Work on the project editing the markdown adding your documentation. Use any IDE of your wish for it. The one I use is [Visual Studio Code](https://code.visualstudio.com/)
### Push changes
```bash
git add .
git commit -m "description of the change"
git push
```
### Pull request
With the changes done and pushed, navigate back to this repo. You'll see that your branch is one commit ahead of main. Click Contribute and then Open a pull request.