Bracket

Bracket is an Elegant static site generator. It encapsulates Jinja2. Its biggest highlight is to render the static pages in the form of view function, and support real-time debugging. It can also support CSS framework, international routing and more functions through ecological extension.

The project is being updated continuously, and the official version has not been completed yet

Installing

Install and update using pip:

$ pip install bracket

A Simple Example

from bracket import WebSite
from jinja2 import Template

app = WebSite(__name__)

@app.pages("/")
def helloworld(context):
    return context({
    "title":"Welcome to Bracket",
    "content":Template('''
        <h1>{{ messages }}</h1>
        <img src="{{ bracket.res('/logo.png')}}">
    '''),
    "resources":{
        "messages":"Welcome to Bracket"
    }
})

app.dispatch("/")

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="generator" content="Bracket & Jinja2 ">
    
    <title>Welcome to Bracket</title>
</head>
<body>
    <div id="bracketapp">
    
        <h1>Welcome to Bracket</h1>
        <img src="/static/logo.png">
        
    </div>
</body>
</html>

Contributing

How to contribute to this project, report problems, and build a development environment, please refer to the contribution guide

License

The project is open source under MIT license in GitHub Community. No one is allowed to infringe the copyright. Please follow LICENSE

#1 Project Development Guide

Project Overview

Pages

Use the view function to render the static interface, and the context will be activated when the view function is running.

from bracket import (WebSite, pages, resources)

app = WebSite(__name__)

@app.pages("/")
def helloworld():
    resources.loader()
    content = pages({
    "title":"Welcome to Bracket",
    "content":Template('''
        <h1>{{ messages }}</h1>
        <img src="{{ bracket.res('/logo.png')}}">
    '''),
    "resources":{
        "messages":"Welcome to Bracket"
    }})
    return content.encode("utf-8")

app.dispatch("/")

Route

When converting the result of view function to static file, route escape function is used

escape("/") # index.html
escape("/bugs") # bugs.html
escape("/u/{{ user.id }}", user=userlist) # /u/1.html, /u/2.html ...

Extension

Users are free to create ecological extensions and publish them to https://pypi.org. Extension is essentially a library.

#bracket_hello.py

from bracket import Extension
from jinja2 import Template

class Hello(Extension):
    def __init__(self,configs):
        self.configs = configs
        self.all = {"createLink": self.createLink}

    def createLink(self,text,link):
        return Template('''<a href="{{ link }}">{{ text }}</a>''').render(text=text,link=link)

bracketing / bracket Goto Github PK

bracket's Introduction

Bracket

Installing

A Simple Example

Contributing

Links

License

bracket's People

Contributors

Stargazers

Watchers

Forkers

bracket's Issues

Project Overview

Pages

Route

Extension

Recommend Projects

Recommend Topics

Recommend Org

Jobs