Git Product home page Git Product logo

py-html-checker-pages's Introduction

Py Html Checker pages

A project to prototype and maintain Py Html Checker exporter templates.

Install

This requires make, Python3, Virtualenv, Pip and C build toolchain to compile C modules.

make install

Usage

Just build everything :

make build

Then run a basic HTTP server to see it:

make run

This is just a quick way to start. There is much more available commands, see help for more details:

make help

You should know than commonly to work on your templates and CSS in live, you will need to launch a watcher for templates, a watcher for Sass sources and a basic HTTP server, you will find these commands in Makefile help.

Finally when you are done, you can build your pages for production environment (search for -prod actions in makefile help).

Overview

Optimus
The static site builder used to build your project. Everything you need to know to manage page, project settings, assets and translations is on Optimus documentation
Jinja
Template syntax engine used in your page templates. Jinja documentation.
CSS

In this project it involves:

  • Sass: the syntax used to write sources to build CSS stylesheets;
  • Boussole: the tool used to build CSS from Sass sources;
  • ITCSS: a structured methodology for Sass/CSS sources files used for shipped Sass sources;

Development

This project help to maintain page templates and CSS stylesheet for Py Html Checker HTML exporter.

It has been built with Optimus builder, but keep in mind than Py Html Checker does not run with Optimus and so won't have all its available features such as assets management, i18n, custom Jinja extensions, etc.. You will have to stand on Py Html Checker exporter limits.

If these limits are respected you should be able to replace Py Html Checker templates with your own and possibly replace the CSS stylesheet also.

py-html-checker-pages's People

Contributors

sveetch avatar

Watchers

James Cloos avatar  avatar  avatar

py-html-checker-pages's Issues

Cleaning for easiest port into py-html-checker

  • Don't wrap anymore document context into export variable such as export.somevar, HTML exporter don't wrap context so it need to be removed each time when porting templates;
  • Move down everything from exports/ to the root of template directory like in exporter;
  • Move assets loader into skeleton, so there is only a single place to modify to replace it with a direct link (since HTML exporter will ship directly the minified CSS, there is not builder involved);
  • Try to add a Makefile action to quickly export templates + minified CSS;
  • Optimus does not set the recent autoescaping feature on Jinja environment but the exporter do it, so there is difference issues in templates on some things like with highlight_html;

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.