Git Product home page Git Product logo

lamb's Introduction

Lamb

Straightforward, extensible, zero configuration public domain static site generator, written in modern TypeScript. Just point Lamb to your site's directory and upload the contents of /out to your host. Comes with a few fancy tricks to make your life easier, such as a handy special import syntax and NextJS-style filesystem routing (with support for MDX and JSX!)

โž” Lamb complements Ashley, the general purpose & public domain forum software that aims to be simple, correct, consistent, and complete. We highly recommend you check it out!

Important

This is WIP software and is not ready for production. You shouldn't use this as anything but a toy at the moment. This document serves as a roadmap, and not necessarily as a list of currently available features.

Overview

  • Use Markdown, MDX, JSX, or HTML. Bring in your favorite web technologies and libraries and they will be bundled into your site.
  • Routing is based on files and directories. index.md compiles into index.html, and /my/favorite/directory/yay.md compiles into /my/favorite/directory/yay.html.
  • Use components instead of Markdown. Export a component from a page ending in .js/.ts/.jsx/.tsx and it will be rendered, similarly to the Pages router for NextJS.
  • Layouts for every directory. Create a special _layout.html (or any of the other supported formats) in any directory to provide a directory-specific layout.
  • Special import syntax. Need to generate content based on the structure of your site, like an index page listing all blog posts? Use import posts from "./*.md" to import all frontmatters in the directory and do stuff with them.
  • Live server. Use lamb dev and navigate to the URL it prints. All changes will be automatically compiled and your browser will reload afterwards.

Usage

Installation

Using a binary

It is possible to run Lamb on its own by downloading a binary for your platform from the Releases page. They are, however, experimental.

Using npm

Install Lamb globally from npm using the following command.

npm install @mblouka/lamb -g

Creating a project

You can install a project in any directory using the lamb init command. This will create a default project configuration in the current directory, with an index.md page, a _layout.html root layout, and a _layout.css default stylesheet.

Building a project

Simply run lamb in the current directory. When no arguments are passed, lamb will just assume you want to build your project. By default, files will be output into /out, but you can change this by altering the lamb.config.json file, which is optional.

License

This is free and unencumbered software released into the public domain. For more information, read the full license.

lamb's People

Contributors

loukamb avatar

Watchers

 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.