| src | ||
| .dockerignore | ||
| .gitignore | ||
| .npmrc | ||
| astro.config.mjs | ||
| deno.jsonc | ||
| Dockerfile | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
ButterflyVu
ButterflyVu is a documentation template built on the Astro Web Framework. It provides a clean, modern, and high-performance foundation for creating technical documentation websites, featuring built-in search capabilities, responsive design, and extensive customization options.
Zero JavaScript
With no client-side JavaScript, your documentation will load fast and efficient for your users, reduce bandwidth overall, improved SEO and accessibility out of box, and more. You also easier content cashing and offline distribution, quicker CI/CD deployments allowing for lower hosting costs, faster contentful paint on slower networks, and other improvements that comes with this perk. All basic functions such as search, are processed server-side.
Full Customizability
With full range of options from the sidebar items, colors, branding, toggles, backgrounds, and much more. Alongside leveraging the volumes portion in Docker Compose you can also go in and override parts of ButterflyVu such as components, layouts, stylesheets, functions, or pretty much anything else. Allowing for full control over customization to tailor it to your project, product, and company.
Open Graph
Comes with built-in Open Graph image support for all pages and documents. Ensuring that every page has a slick, professional-looking embed preview including specific logo, image, title, and category; when it's shared across platforms. The Open Graph image is also fully customizable so it's tailored to your product and branding.
Privacy Friendly
ButterflyVu does not bake in advertisements or trackers anywhere on the pages, making it privacy friendly for all users. Especailly with it's Zero JavaScript client-side promise.
Docker Ready
ButterflyVu is built to be hosted with Docker, making it ready to go out-of-box without any other extra dependencies for your system.
Search
ButterflyVu has it's own built-in search solution, which is processed with server-side rendering which allows for zero JavaScript client-side. Making it fast for users browsing your documentation.
License
MIT NON-AI License
Copyright (c) 2024 - 2026 SudoVanilla
Permission is hereby granted, free of charge, to any person obtaining a copy of the software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
In addition, the following restrictions apply:
1. The Software and any modifications made to it may not be used for the purpose of training or improving machine learning algorithms,
including but not limited to artificial intelligence, natural language processing, or data mining. This condition applies to any derivatives,
modifications, or updates based on the Software code. Any usage of the Software in an AI-training dataset is considered a breach of this License.
2. The Software may not be included in any dataset used for training or improving machine learning algorithms,
including but not limited to artificial intelligence, natural language processing, or data mining.
3. Any person or organization found to be in violation of these restrictions will be subject to legal action and may be held liable
for any damages resulting from such use.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.