Guidemaker
A fully-functional, static site implementation of a documentation site and is built on EmberJS and using Empress technologies
Overview
Guidemaker is a robust solution for creating static documentation sites, built on the reliable EmberJS framework. Designed for efficiency, it outputs SEO-friendly content that can be easily hosted on platforms like AWS S3 or other static hosting services. This system encapsulates core functionalities while providing flexibility through separate packages dedicated to themes and styling, allowing users to customize their documentation's appearance seamlessly.
Whether you're an experienced developer or a newcomer, Guidemaker simplifies the process of writing and deploying documentation. By writing markdown files, users can leverage the powerful EmberJS build system to generate a fully functional website without diving deep into coding specifics. This makes it an accessible option for anyone looking to create professional documentation quickly.
Features
- SEO Friendly Output: Automatically generates a documentation site optimized for search engines, enhancing visibility and accessibility.
- Multiple Hosting Options: Easily host your site on AWS S3 or any other preferred static site hosting service.
- Default and Custom Themes: Comes with the Guidemaker Default Template for a basic start, while supporting the creation of custom themes for personalized styles.
- Simple Deployment: Deploy your documentation site to Netlify in under a minute with a single button click, setting up a GitHub repository and continuous deployment automatically.
- Local Development: Test and preview your site locally before going live, ensuring everything works as intended with a straightforward build process.
- Easy Configuration: Modify your configuration easily through
config/environment.js, tailored to your specific documentation needs. - No Coding Required: With a focus on markdown files, you don’t need to be a web developer to utilize the system effectively, making it accessible for all users.
- Community Support: Engage with others and contribute to the project, with resources available for those interested in creating their own themes.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Stylelint
Stylelint is a modern linter for CSS that helps you avoid errors and enforce consistent styling conventions. It provides rules for detecting errors and warnings, and can be configured to match your specific project's requirements.
- Webpack
Webpack is a popular open-source module bundler for JavaScript applications that bundles and optimizes the code and its dependencies for production-ready deployment. It can also be used to transform other types of assets such as CSS, images, and fonts.