Coder Social home page Coder Social logo

doxx's Introduction

doxx icon doxx

Documentation

http://doxx.org

What is doxx?

doxx is a generic text file project build and distribution system. It supports simple YAML formatted build specs and build time text file customization using local or remote text templates (that can be hosted anywhere).

For those who prefer the ready-made approach, the doxx Package Repository contains a growing list of resusable, common project types that can be built with a simple set of doxx commands.

Features include:

  • Generic text project support. Use it for anything from a Bootstrap framework driven website to a statistical analysis script stub. If it contains text, it should work.
  • Simple, legible YAML syntax build specs that do not require scripting/programming know-how
  • Local template file support
  • Remote template file support (from any hosting site that supports GET requests)
  • Github pull shortcodes allow you to include entire Github repositories or cherry pick specific repository files or directories for your project
  • Full UTF-8 character set support in templates, named text replacement tags in templates, and replacement strings entered by users
  • Support for the distribution of binary files with your projects
  • Multi-processor template file build support

Additional information is available in the documentation.

Quickstart Guides

User Quickstart Guide

The User Quickstart Guide demonstrates how to build projects from third party developers or from the doxx Package Repository.

Developer Quickstart Guide

The Developer Quickstart Guide demonstrates how to develop and distribute reusable, templated projects with doxx.

Usage

The Usage Documentation lists the complete set of available commands and options.

Changes

Changes are found on the Changelog.

Issues

Please submit a new issue report on the Github repository.

License

The doxx command line application is licensed under the MIT License.

Project packages distributed through the doxx Package Repository are licensed under a variety of open source licenses. Please review the respective project documentation for additional information.

doxx's People

Contributors

chrissimpkins avatar

Watchers

James Cloos avatar Joseph Santana avatar

Forkers

tstyle kolo305

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.