https://github.com/dhanushnehru/static-site-generator
An opensource static site generator
https://github.com/dhanushnehru/static-site-generator
contributions-welcome javascript opensource static static-site-generator typescript website-development website-template
Last synced: 7 months ago
JSON representation
An opensource static site generator
- Host: GitHub
- URL: https://github.com/dhanushnehru/static-site-generator
- Owner: DhanushNehru
- License: mit
- Created: 2024-07-12T14:14:12.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-12T14:27:54.000Z (about 1 year ago)
- Last Synced: 2025-02-25T17:17:23.289Z (8 months ago)
- Topics: contributions-welcome, javascript, opensource, static, static-site-generator, typescript, website-development, website-template
- Language: JavaScript
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Static Site Generator
A simple static site generator built with TypeScript. This tool reads markdown files from a `content` directory and generates static HTML files in an `output` directory.
## Features
- Converts Markdown to HTML
- Generates static HTML files
- Easy to extend and customize
## Requirements
- Node.js
- npm (Node Package Manager)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/DhanushNehru/static-site-generator.git
cd static-site-generator
```
2. Install dependencies:
```bash
npm install
```
## Usage
1. Add your markdown files to the `content` directory. For example, create `index.md` and `about.md`.
```markdown
# content/index.md
# Home Page
Welcome to the home page!
```
```markdown
# content/about.md
# About Page
This is the about page.
```
2. Run the static site generator:
```bash
npm run generate
```
## Development
To develop and extend this project, follow these steps:
1. Make changes to the TypeScript files in the `src` directory.
2. Compile the TypeScript files:
```bash
npm run build
```
3. Run the generator to see the changes:
```bash
npm run generate
```
## Contributing
Contributions are welcome! If you have suggestions for improvements or new features, please open an issue or submit a pull request.
## Gitpod
In the cloud-free development environment where you can directly start coding.
You can use Gitpod in the cloud [](https://gitpod.io/#https://github.com/DhanushNehru/static-site-generator/)
----
### Connect 👉 [**Twitter**](https://twitter.com/Dhanush_Nehru) **/** [**Instagram**](https://www.instagram.com/dhanush_nehru/) **/** [**Github**](https://github.com/DhanushNehru/) **/** [**Youtube**](https://www.youtube.com/@dhanushnehru?sub_confirmation=1) **/** [**Newsletter**](https://dhanushn.substack.com/) **/** [**Discord**](https://discord.com/invite/Yn9g6KuWyA)