SSS is a minimal, Node.js-based static site generator that converts Markdown files into HTML pages. It's designed to be extremely simple, fast, and easy to use.
- Converts Markdown files to HTML
- Development mode with file watching and automatic recompilation
- Respects system dark mode preferences
- RSS feed generation
- Custom markdown extensions (definition lists, tweet embeds, footnotes)
-
Clone this repository:
git clone https://github.com/thenanyu/sss.git cd sss -
Install dependencies:
npm install
- Place your Markdown files in the
pagesdirectory. - Put your assets (images, etc.) in the
assetsdirectory. - Customize the
styles.cssfile for your design preferences.
For development with automatic file watching and recompilation:
npm run dev
This will build your site and watch for changes in Markdown files, JavaScript files, and styles.css, automatically rebuilding when changes are detected.
For a one-time build (useful for deployment):
npm run build
This will generate HTML files in the dist directory without starting the file watcher.
To create a new blog entry or page:
npm run new
This will help you create a new Markdown file with the proper naming convention.
project_root/
├── pages/ # Your Markdown files go here
│ ├── writing/ # Blog posts with date-based naming
│ └── index.md # Main page
├── assets/ # Static assets (images, etc.)
├── styles.css # Custom styles
├── dist/ # Generated HTML files (do not edit directly)
├── build.js # Build script (production)
├── dev.js # Development script (build + watch)
├── watcher.js # File watching functionality
├── new-post.js # Script for creating new entries
└── package.json
Contributions are welcome! Please feel free to submit a Pull Request.
This project is open source and available under the MIT License.
Created by Nan Yu and his friendly team of AI helpers