https://github.com/clearloop/omi

The static site generator
https://github.com/clearloop/omi

Last synced: about 2 months ago
JSON representation

The static site generator

• Host: GitHub
• URL: https://github.com/clearloop/omi
• Owner: clearloop
• License: gpl-3.0
• Created: 2023-12-29T02:22:59.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-02T22:37:32.000Z (11 months ago)
• Last Synced: 2024-11-06T13:56:57.598Z (2 months ago)
• Language: Rust
• Homepage: https://clearloop.github.io/cydonia/
• Size: 220 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cydonia

[![cydonia][version-badge]][version-link]

[![ci][ci-badge]][ci-link]

## Usage

```bash

cargo install cydonia

cydonia init blog

cydonia serve blog

```

The minimal directory layout is like below, see [cydonia.toml](./blog/cydonia.toml)

for the full configuration.

```

my-blog

├── cydonia.toml

└── posts

    └── 2024-01-01-hello-world.md

```

## Github Action

```yaml

name: Cydonia

on:

  push:

    branches: [main]

jobs:

  deploy:

    name: Deploy

    runs-on: ubuntu-22.04

    permissions:

      contents: write

    steps:

      - uses: actions/checkout@v4

      - uses: clearloop/[email protected]

      - name: Build the site

        run: cydonia build blog

      - name: Deploy

        uses: peaceiris/actions-gh-pages@v3

        with:

          github_token: ${{ secrets.GITHUB_TOKEN }}

          publish_dir: ./blog/out

```

## LICENSE

GPL-3.0-only

[version-badge]: https://img.shields.io/crates/v/cydonia

[version-link]: https://docs.rs/cydonia

[ci-badge]: https://img.shields.io/github/actions/workflow/status/clearloop/cydonia/main.yml

[ci-link]: https://github.com/clearloop/cydonia/actions/workflows/main.yml