https://github.com/sujaudd1n/scribo

A simple, efficient and content-first static site generator (SSG).
https://github.com/sujaudd1n/scribo

documentation documentation-generator jinja markdown static-site-generator

Last synced: 3 months ago
JSON representation

A simple, efficient and content-first static site generator (SSG).

• Host: GitHub
• URL: https://github.com/sujaudd1n/scribo
• Owner: sujaudd1n
• License: mit
• Created: 2024-06-20T18:09:18.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-28T19:33:35.000Z (6 months ago)
• Last Synced: 2025-04-15T14:03:45.746Z (6 months ago)
• Topics: documentation, documentation-generator, jinja, markdown, static-site-generator
• Language: Python
• Homepage: https://scribo-docs.netlify.app/
• Size: 1.85 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

          


    





A simple, efficient and content-first static site generator (SSG). 





![License](https://img.shields.io/badge/License-MIT-green)

[![PyPI - Version](https://img.shields.io/pypi/v/scribo.svg)](https://pypi.org/project/scribo)

    



Write docs, blogs or anything you like. Read the [docs](https://scribo-docs.netlify.app).

## Features

- Extended markdown syntax support

- File-system based routing

- Customization

- Automatic table of contents generation

- Syntax highlighting of codeblocks

- Metadata

## Installation

```console

pip install scribo

```

## Quick Start

### Initialize

```bash

scribo --init sitename

```

Edit `index.md`.

### Build

```console

scribo --build sitename

```

`dist` dir contains the build of the project.

## Contributing

Please read [CONTRIBUTING.md](./CONTRIBUTING.md).

## License

`scribo` is distributed under the terms of the [MIT](./LICENSE) license.