{"id":20324941,"url":"https://github.com/mainsail-crew/gb-docs","last_synced_at":"2025-06-11T17:03:21.316Z","repository":{"id":169396787,"uuid":"511531144","full_name":"mainsail-crew/gb-docs","owner":"mainsail-crew","description":"📖 Documentation for Mainsail - including step-by-step installation guides","archived":false,"fork":false,"pushed_at":"2025-04-15T08:30:55.000Z","size":9302,"stargazers_count":1,"open_issues_count":1,"forks_count":13,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-09T21:57:53.084Z","etag":null,"topics":["documentation","klipper","mainsail","mainsailos","moonraker","raspberry-pi"],"latest_commit_sha":null,"homepage":"https://docs.mainsail.xyz","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mainsail-crew.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-07-07T13:05:56.000Z","updated_at":"2025-04-15T08:30:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"cfc7ea77-62d2-40a8-a744-a099af18d528","html_url":"https://github.com/mainsail-crew/gb-docs","commit_stats":null,"previous_names":["mainsail-crew/gb-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mainsail-crew/gb-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainsail-crew%2Fgb-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainsail-crew%2Fgb-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainsail-crew%2Fgb-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainsail-crew%2Fgb-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mainsail-crew","download_url":"https://codeload.github.com/mainsail-crew/gb-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mainsail-crew%2Fgb-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259301677,"owners_count":22836976,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","klipper","mainsail","mainsailos","moonraker","raspberry-pi"],"created_at":"2024-11-14T19:38:14.840Z","updated_at":"2025-06-11T17:03:21.294Z","avatar_url":"https://github.com/mainsail-crew.png","language":"JavaScript","funding_links":["https://www.patreon.com/meteyou","https://github.com/sponsors/mainsail-crew","https://ko-fi.com/mainsail"],"categories":[],"sub_categories":[],"readme":"---\ndescription: \u003e-\n  A modern and responsive user interface for Klipper. Control and monitor your\n  printer from everywhere, from any device.\ncover: .gitbook/assets/Mainsail_SB.jpg\ncoverY: 0\n---\n\n# Welcome to Mainsail\n\n\u003cmark style=\"color:red;\"\u003e**Easy to use.**\u003c/mark\u003e The focus lies on both anticipating what users may need to do and ensuring that the user interface contains elements that are easily accessible, understandable, and user-friendly to make those actions easier.\n\n\u003cmark style=\"color:red;\"\u003e**Always one step ahead.**\u003c/mark\u003e We work closely with developers of other projects so that functions can already be implemented early on.\n\n\u003cmark style=\"color:red;\"\u003e**100% open source.**\u003c/mark\u003e Anyone can join, anyone can contribute.\n\n## Getting started\n\n{% content-ref url=\"setup/getting-started/\" %}\n[getting-started](setup/getting-started/)\n{% endcontent-ref %}\n\n## Screenshots\n\n\u003cfigure\u003e\u003cimg src=\".gitbook/assets/screenshot.png\" alt=\"\"\u003e\u003cfigcaption\u003e\u003cp\u003eScreenshot Dashboard (Mobile \u0026#x26; Desktop)\u003c/p\u003e\u003c/figcaption\u003e\u003c/figure\u003e\n\n\u003cfigure\u003e\u003cimg src=\".gitbook/assets/image (5).png\" alt=\"\"\u003e\u003cfigcaption\u003e\u003cp\u003eHeightmap, G-code viewer, Farm mode\u003c/p\u003e\u003c/figcaption\u003e\u003c/figure\u003e\n\n## Features\n\n* **Responsive Web Interface:** _Optimized for desktops, tablets and mobile devices_\n* **Printer Farm:** _Supports multiple 3D printers_\n* **Localization:** _Choose between 12 different languages_\n* **File Manager:** _Delete, rename and upload your G-Code and config files_\n* **File Editor:** _Edit G-Code and config files with syntax highlighting in your browser_\n* **Print History:** _See your previous prints and their status_\n* **Statistics:** _View how much time your printer has been in use and the number of jobs that have succeeded or failed_\n* **Job Queue:** _Queue multiple jobs and add them directly from your slicer_\n* **Temperature Presets:** _Manage different temperature presets for easy preheating_\n* **Bed Mesh Visualisation:** _View your bed using a 3D mesh graph_\n* **G-Code Viewer:** _View a 3D render of your print and follow the progress_\n* **Multi-Webcam Support:** _View your print from different angles with multiple webcams_\n* **Timelapse Integration:** _Automatically record a timelapse of your print using_ [_moonraker-timelapse_](https://github.com/mainsail-crew/moonraker-timelapse)\n* **Power Control:** _Control power devices such as relays, TP-Link and Tasmota devices, and more_\n* **Powerful Macro-Management:** _Manage your macros on a micro level_\n* **Configurable Dashboard:** _Create your own personal dashboard_\n* **Theming Support:** _Customizable user interface including logos, backgrounds, and custom CSS_\n* **Additional Sensors:** _Add extra sensors to the temperature graph_\n* **Exclude Objects:** _Exclude parts of your print_\n\n## Help and Support\n\nDo you need help or just want to talk? Join our active community on Discord. Have you found a bug? Please create an Issue in GitHub and let us know.\n\n* [Discord](https://discord.gg/skWTwTD)\n* [GitHub Issues](https://github.com/mainsail-crew/mainsail/issues)\n\n## Support Mainsail\n\nMainsail is primarily developed and maintained by `meteyou`. To keep the project going he invests his free time, almost every day. To motivate him (☕🍺😜) there are several ways to support him:\n\n* [Patreon](https://www.patreon.com/meteyou) (recurring)\n* [GitHub](https://github.com/sponsors/mainsail-crew) (recurring or one-time)\n* [Ko-Fi](https://ko-fi.com/mainsail) (one-time)\n\n{% hint style=\"info\" %}\nPlease also support all of our maintainers and contributors.\n{% endhint %}\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmainsail-crew%2Fgb-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmainsail-crew%2Fgb-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmainsail-crew%2Fgb-docs/lists"}