Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iambijoykar/jamun
Static webpage builder with Markdown support and file based routing.
https://github.com/iambijoykar/jamun
file-based-routing html markdown npm-module npm-package static-site-generator typescript web-framework
Last synced: 2 months ago
JSON representation
Static webpage builder with Markdown support and file based routing.
- Host: GitHub
- URL: https://github.com/iambijoykar/jamun
- Owner: iamBijoyKar
- License: mit
- Created: 2024-01-24T18:19:27.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-06-20T15:15:16.000Z (7 months ago)
- Last Synced: 2024-09-23T07:37:32.308Z (3 months ago)
- Topics: file-based-routing, html, markdown, npm-module, npm-package, static-site-generator, typescript, web-framework
- Language: TypeScript
- Homepage:
- Size: 36.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Jamun
A simple and lightweight Static Site Generator with features like markdown support, directory structure routing, and more.
> **Note**: This project is still in very very early stages of development. It may not be stable and may not have all the features you need. Please use it at your own risk.
## Features
- **Markdown Support**: Write your content in markdown and Jamun will convert it to HTML.
- **File Based Routing**: Jamun uses the directory structure and files to create routes for your website. It also supports markdown or html files as pages.
## Future Features
- **Themes**: Support for themes to customize the look and feel of your website.
- **Plugins**: Support for plugins to extend the functionality of Jamun.
- **Components**: Support for components to reuse code across pages.
- **Reactive Components**: Support for reactive components using Svelte or React.
## Purpose
The purpose of this project is to create a simple and lightweight static site generator that can be used to create websites with minimal effort. It is inspired by projects like Gatbsy, Astro etc. But it aims to be simpler and more lightweight. The main target of this project is to create text heavy websites like blogs, documentation etc with minimal effort.
## Create a new project
To create a new project with Jamun, you can use the following command:
```bash
npx create-jamun
```
> **Note**: The npm package is not upto date with the latest changes. So, it is recommended to clone the repository and use it directly. Follow this [Guidelines](./direct-setup.md)
Change dirs
```bash
cd
```
Installations
```bash
npm install
```
Run the project
```bash
npm run dev
```
## Contributing
If you are interested in contributing to this project, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file.