Krems

Overview

Krems is an innovative tool designed for users aiming to publish Markdown websites seamlessly to GitHub Pages. It simplifies the process of getting a site online, providing an intuitive way to manage and host content directly from a repository. Whether you're a developer looking to showcase your projects or a blogger eager to share your thoughts, Krems offers a straightforward solution that combines the power of Markdown with the convenience of GitHub.

By following a few simple steps, users can fork an example site, enable the necessary workflows, and witness their creation come to life as a fully functioning website. Krems not only facilitates easy deployment but also encourages customization through its configuration options, allowing users to tailor their sites to suit their individual needs.

Features

• Easy Setup: Fork the example site, enable the required workflows, and let Krems handle the deployment to GitHub Pages.
• Markdown Support: Publish content using Markdown, making it accessible and easy to format for users of all skill levels.
• Customizable Configuration: Modify the config.yaml file to include personalized CSS, JavaScript, and favicon paths to enhance the site's appearance.
• Image Management: Organize images in an /images folder and reference them in Markdown, ensuring neatness and easy access.
• Two Page Types: Choose between list pages that display links to other pages or default pages that contain Markdown content—ideal for diverse content management.
• Local Development: Run the Krems site locally using simple commands, enabling easy testing and previewing before public deployment.
• GitHub Action Integration: Automatically generates the site upon a push and commits it to the gh-pages branch, streamlining the deployment process.
• Active Community Contribution: Users can contribute to Krems by submitting pull requests, fostering a collaborative development environment.