https://github.com/shobhit-nagpal/statgen
A static site generator for converting markdown to HTML, rewritten in Golang
https://github.com/shobhit-nagpal/statgen
bash go golang markdown-parser markdown-to-html static-site-generator
Last synced: 5 months ago
JSON representation
A static site generator for converting markdown to HTML, rewritten in Golang
- Host: GitHub
- URL: https://github.com/shobhit-nagpal/statgen
- Owner: Shobhit-Nagpal
- Created: 2024-04-29T15:30:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-16T15:46:41.000Z (over 1 year ago)
- Last Synced: 2025-02-17T05:17:21.756Z (8 months ago)
- Topics: bash, go, golang, markdown-parser, markdown-to-html, static-site-generator
- Language: Go
- Homepage:
- Size: 2.09 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Statgen
Statgen is a simple and efficient static site generator written in Go. With Statgen, you can easily create static websites from markdown files, allowing you to focus on content creation without worrying about the complexities of web development.
This is a Go rewrite after having the first version written in Python following steps from [Boot.dev](https://boot.dev/)
## Features
- **Markdown Support:** Write your content in markdown format, a simple and intuitive markup language.
- **Fast Rendering:** Quickly generate static websites without the need for server-side processing.
- **Command-Line Interface:** Use the command-line interface to generate your website with a single command.
## Installation
To install Statgen, simply use `go get`:
```bash
go get -u github.com/Shobhit-Nagpal/statgen
```
Make sure your Go environment is set up correctly.
## Usage
Here's a basic example of how to use Statgen:
### Clone the repo
```bash
git clone git@github.com:Shobhit-Nagpal/statgen.git
```
### Run main shell script
```bash
./main.sh
```
This command runs your static website using the markdown files in the `content` directory and the templates in the `templates` directory. The generated website will be placed in the `public` directory.
## Contributing
Contributions are welcome! If you have ideas for new features, improvements, or bug fixes, feel free to open an issue or submit a pull request.
## Acknowledgements
A huge shoutout to [Boot.dev](https://boot.dev/) for breaking down how to make a static site generator on your own.