https://github.com/lukasbach/markbase
Quickly generate an HTML page from a bunch of markdown files
https://github.com/lukasbach/markbase
cli docs documentation fast generate homepage html markdown tool website
Last synced: about 2 months ago
JSON representation
Quickly generate an HTML page from a bunch of markdown files
- Host: GitHub
- URL: https://github.com/lukasbach/markbase
- Owner: lukasbach
- License: mit
- Created: 2023-12-12T00:51:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T17:48:32.000Z (about 2 years ago)
- Last Synced: 2025-10-28T08:39:31.260Z (8 months ago)
- Topics: cli, docs, documentation, fast, generate, homepage, html, markdown, tool, website
- Language: TypeScript
- Homepage: https://markbase.lukasbach.com/
- Size: 631 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.MD
- License: LICENSE
Awesome Lists containing this project
README
# Markbase
Markbase is a simple, lightweight, and fast static site generator that turns a bunch of markdown files into a website.
Features:
- As simple as it can get, just call `markbase build folder/to/markdown/files` to get your output
- Watch mode, just call `markbase watch folder/to/markdown/files` to open a local server and automatically rebuild your site on file changes
- Modern theme with dark- and light mode
- Syntax highlighting in code segments
- [Admonitions and lots of other extended markdown features](https://markbase.lukasbach.com/syntax/)
- Customization of [document names](https://markbase.lukasbach.com/title/) and [order](https://markbase.lukasbach.com/order/) through frontmatter or folder config files
- Generates SEO tags, sitemap file and favicons
- Lots of customizability through [custom plugins](https://markbase.lukasbach.com/plugins/)
## Get Started
Install markbase with
```bash
npm install -g markbase
```
Then, run
```bash
markbase build folder/to/markdown/files
```
to generate your website. The output will be in the `./out` folder.
You can also use `markbase watch` to automatically rebuild your site on file changes.
## Configuration
You can configure how markbase generates your site by creating a configuration file `config.yml` at the root of your
document folder:
```yaml
title: My Website
description: This is my website
documents: ["**/*.md"]
assets: ["**/*.png", "**/*.jpg"]
out: ./dist
```
See [here](https://markbase.lukasbach.com/config/) for more information on the configuration options.