Giter Club home page Giter Club logo

roxy's Introduction

Roxy

This is a very lightweight and small static site generator. This is a highly unstable project with no promises of consistent API or even that it's functioning. Use with caution.

Usage

roxy --layouts ./layouts --content ./content --output ./build --theme theme.tmTheme

Layouts

Roxy layouts are made with Tera templates. Most of the functionality of Roxy comes from Tera.

Content

Content files are a combination of Frontmatter and Markdown (separated by dashes.)

title: My first post!
---
Hello, Roxy!

There is one special Frontmatter field: layout. By default, this will be index.html (from whatever directory is selected as the layouts folder). Setting this field will change the template Roxy uses for this file.

title: My post with a custom layout
layout: special.tera
---
# Fancy!

Markdown is parsed using pulldown-cmark.

Themes

Roxy takes any theme which is accepted by syntect.

roxy's People

Contributors

kitsunecafe avatar

Stargazers

ilobmirt avatar

Watchers

 avatar Lilith avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.