Coder Social home page Coder Social logo

handroll

PyPI version BSD license Build Status Coverage Status

Website development is a finely crafted art.

You need simple. You know what you're doing. You don't want to waste time.

handroll knows you are the boss. With one command, you gracefully blend your theme and content into one precise result.

$ pip install handroll
...
Successfully installed handroll
$ handroll build site
Complete.

Just the facts

handroll walks your website source (i.e. site as shown above), copying everything that it can find. When it encounters:

  1. anything ending in .md, the file will be read, the first line of the file will become the title, and the remainder will be converted from Markdown into HTML to become the content. title and content will be combined with a template to produce the final HTML file.
  2. any other "known" extension will be handled by a corresponding composer. handroll works with Markdown, reStructuredText, and Textile out of the box.
  3. a template (either template.html or anything in templates), the file will be skipped.

Everything else

Check out the feature list to see if handroll meets your needs. If not, please tell us with a GitHub issue or on the mailing list.

All the other stuff you may be interested in regarding handroll (e.g., writing a plugin for your favorite markup language) is found at Read the Docs.

If you want to share some ideas or find announcements, check out the Google Group.

handroll is BSD licensed and tested on Linux and OS X.

Get Involved

Bring an idea to the table! Implement it in a fork or submit an issue to have some discussion about it.

handroll needs a better identity. If you're a web developer or designer, please consider helping with a logo.

Translators can join the fun by translating at the Transifex project. Additional translation details are in thetranslation documentation.

Want to write some code? Running these commands should set up your environment with all the tools you need to contribute.

$ # Start from the root of a handroll clone.
$ virtualenv venv                            # Create your virtual environment.
$ source venv/bin/activate                   # Activate it.
(venv)$ pip install -r requirements-dev.txt  # Install developer tools.
(venv)$ pip install -e .                     # Install handroll in editable mode.
(venv)$ pytest                              # Run the test suite.

handoll team's Projects

handroll icon handroll

:bento: A website generator for software artisans

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.