# Plugen
Plugen is a pluggable static website generator designed to make building static websites fast, flexible, and easy. With its modular architecture, Plugen allows you to extend and customize its functionality through plugins, making it a versatile tool for creating a wide range of static websites.
## Features
- **Modularity**: Plugen is built on a modular architecture that enables the use of plugins. You can easily extend its functionality by installing and configuring plugins tailored to your specific needs.
- **Flexible Templating**: Plugen supports various templating engines, allowing you to choose the one that suits your preferences or requirements. You can use popular templating engines like Handlebars, Jinja, or even create your own.
- **Asset Management**: Easily manage your website's assets, including stylesheets, JavaScript files, images, and more. Plugen provides asset bundling and minification to optimize your site's performance.
- **Markdown Support**: Write your content in Markdown and let Plugen convert it into HTML automatically. Markdown makes it easy to write structured content without the need for complex HTML markup.
- **Theme Support**: Plugen provides a theming system that allows you to apply pre-built themes to your website or create your own. Themes define the overall look and feel of your site, including layout, typography, and color schemes.
- **SEO Optimization**: Plugen includes features to help optimize your website for search engines. You can define metadata, such as title tags and meta descriptions, for each page to improve search engine visibility.
- **Command-Line Interface (CLI)**: Plugen comes with a powerful CLI that provides a simple and intuitive way to generate your static website. Use commands like `plugen build` to generate your site or `plugen serve` to preview it locally during development.
## Getting Started
Follow these steps to get started with Plugen:
1. **Installation**: Install Plugen globally using pipx:
```shell
$ pipx install plugen
```
Then, on any folder, run the following command to set up a configuration file
```shell
$ plugen init
```
2. **Build your website**: Run the following command to generate your static website:
```shell
$ plugen build
```
3. **Serve your website**: To preview your website locally, use the following command:
```shell
$ plugen serve
```
This will start a local development server, and you can access your website at `http://localhost:3000`.
4. **Customize and extend**: Explore Plugen's plugin ecosystem and customize your website further to meet your specific requirements. Visit the Plugen documentation for more details.
## Additional documentation
If you need more help, feel free to check out:
- DOCUMENTATION.md : Technical documentation, and configuration of the plugin files
- CONTRIBUTING.md : A guide on how to develop your own plugins
## Contributing
Contributions are welcome! If you find a bug, have a feature request, or want to contribute improvements or new plugins to Plugen, please create an issue or submit a pull request on the [GitHub repository](https://github.com/plugen/plugen).
Before submitting a pull request, please make sure to review the [contribution guidelines](CONTRIBUTING.md).
## License
Plugen is released under the [MIT License](LICENSE). Feel free to use, modify, and distribute it as per the terms of the license.
## Acknowledgments
We would like to thank all the contributors who have helped make Plugen better.
## Support
If you have any questions or need assistance, you can reach out to the Plugen community on our [Discord server](https://discord.com/plugen) or by opening an issue on the GitHub repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/aclarembeau/plugen",
"name": "plugen",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "static website generator",
"author": "Clarembeau Alexis",
"author_email": "alexis.clarembeau@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/42/b6/70d3eaf6f207f941d325b2ca56d156baf0a8ea68e88b4322a465241b88bc/plugen-1.1.2.tar.gz",
"platform": null,
"description": "# Plugen\n\nPlugen is a pluggable static website generator designed to make building static websites fast, flexible, and easy. With its modular architecture, Plugen allows you to extend and customize its functionality through plugins, making it a versatile tool for creating a wide range of static websites.\n\n## Features\n\n- **Modularity**: Plugen is built on a modular architecture that enables the use of plugins. You can easily extend its functionality by installing and configuring plugins tailored to your specific needs.\n\n- **Flexible Templating**: Plugen supports various templating engines, allowing you to choose the one that suits your preferences or requirements. You can use popular templating engines like Handlebars, Jinja, or even create your own.\n\n- **Asset Management**: Easily manage your website's assets, including stylesheets, JavaScript files, images, and more. Plugen provides asset bundling and minification to optimize your site's performance.\n\n- **Markdown Support**: Write your content in Markdown and let Plugen convert it into HTML automatically. Markdown makes it easy to write structured content without the need for complex HTML markup.\n\n- **Theme Support**: Plugen provides a theming system that allows you to apply pre-built themes to your website or create your own. Themes define the overall look and feel of your site, including layout, typography, and color schemes.\n\n- **SEO Optimization**: Plugen includes features to help optimize your website for search engines. You can define metadata, such as title tags and meta descriptions, for each page to improve search engine visibility.\n\n- **Command-Line Interface (CLI)**: Plugen comes with a powerful CLI that provides a simple and intuitive way to generate your static website. Use commands like `plugen build` to generate your site or `plugen serve` to preview it locally during development.\n\n## Getting Started\n\nFollow these steps to get started with Plugen:\n\n1. **Installation**: Install Plugen globally using pipx:\n\n ```shell\n $ pipx install plugen\n ```\n \n Then, on any folder, run the following command to set up a configuration file \n\n ```shell \n $ plugen init\n ```\n\n2. **Build your website**: Run the following command to generate your static website:\n\n ```shell\n $ plugen build\n ```\n\n3. **Serve your website**: To preview your website locally, use the following command:\n\n ```shell\n $ plugen serve\n ```\n\n This will start a local development server, and you can access your website at `http://localhost:3000`.\n\n4. **Customize and extend**: Explore Plugen's plugin ecosystem and customize your website further to meet your specific requirements. Visit the Plugen documentation for more details.\n\n## Additional documentation \n\nIf you need more help, feel free to check out:\n\n - DOCUMENTATION.md : Technical documentation, and configuration of the plugin files \n - CONTRIBUTING.md : A guide on how to develop your own plugins\n\n## Contributing\n\nContributions are welcome! If you find a bug, have a feature request, or want to contribute improvements or new plugins to Plugen, please create an issue or submit a pull request on the [GitHub repository](https://github.com/plugen/plugen).\n\nBefore submitting a pull request, please make sure to review the [contribution guidelines](CONTRIBUTING.md).\n\n## License\n\nPlugen is released under the [MIT License](LICENSE). Feel free to use, modify, and distribute it as per the terms of the license.\n\n## Acknowledgments\n\nWe would like to thank all the contributors who have helped make Plugen better.\n\n## Support\n\nIf you have any questions or need assistance, you can reach out to the Plugen community on our [Discord server](https://discord.com/plugen) or by opening an issue on the GitHub repository.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/aclarembeau/plugen"
},
"split_keywords": [
"static",
"website",
"generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "42b670d3eaf6f207f941d325b2ca56d156baf0a8ea68e88b4322a465241b88bc",
"md5": "2462d8f3c222ea5bef434a2f8d4f0d5e",
"sha256": "92c9bf21ee5c5b83f312f06f26a98512fc7a4b7cb152ab404c6cde3aaccb6151"
},
"downloads": -1,
"filename": "plugen-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "2462d8f3c222ea5bef434a2f8d4f0d5e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9205,
"upload_time": "2023-07-12T19:07:12",
"upload_time_iso_8601": "2023-07-12T19:07:12.713608Z",
"url": "https://files.pythonhosted.org/packages/42/b6/70d3eaf6f207f941d325b2ca56d156baf0a8ea68e88b4322a465241b88bc/plugen-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-12 19:07:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aclarembeau",
"github_project": "plugen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "plugen"
}
JSON
