https://github.com/harshithmullapudi/tsukuru
minimal mdx static site generator
https://github.com/harshithmullapudi/tsukuru
mdx nextjs react
Last synced: about 1 month ago
JSON representation
minimal mdx static site generator
- Host: GitHub
- URL: https://github.com/harshithmullapudi/tsukuru
- Owner: harshithmullapudi
- License: mit
- Created: 2024-08-06T10:20:39.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T04:07:04.000Z (10 months ago)
- Last Synced: 2025-04-12T04:45:02.704Z (about 1 month ago)
- Topics: mdx, nextjs, react
- Language: TypeScript
- Homepage:
- Size: 135 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tsukuru
minimal mdx static site generator
## Overview
Easy personal website creator with nextjs, shadcn and MDX. Example [site](https://github.com/harshithmullapudi/harshith.sh). This repository has the necessary nextjs app and the cli package to run the app.
## Setup
1. Create a new folder with tsukuru.json and the respective MDX files
```
{
"$schema": "http://json-schema.org/draft-07/schema#",
"name": "Harshith.sh",
"description": "This is my personal blog",
"navigation": [
{
"group": "Harshith",
"pages": [ "about" ]
},
{
"group": "Anime",
"pages": [ "anime", "anime/naruto" ]
}
],
"socials": {
"github": "https://github.com/harshithmullapudi"
}
}
```
2. Run `npx @born4rhell/tsukuru setup` to setup the repo in local
3. Run `npx @born4rhell/tsukuru dev` to run the website in http://localhost:3000
## TODO
- [ ] fix mobile view
- [ ] dropdown feature on top nav
- [ ] easy vercel deployment
- [ ] theme support