Giter Club home page Giter Club logo

mix_templates's Introduction

Mix Template—create customized directory trees

The templating package that allows you to create custom directory trees for your Elixir project.

Manage the local installation and uninstallation of templates used by mix gen.

Install

$ mix archive.install hex mix_templates

You probably also need to install the generator:

$ mix archive.install hex mix_generator

Use

A high-level summary:

  • mix template

    List the locally installed templates.

  • mix template.hex

    List the templates available on hex.

  • mix template.install «source»

    Install a template from source.

  • mix template.uninstall «name»

    Uninstall the template with the given name.

  • `mix template «name» --help

    Get template-specific help. Useful to discover the extra options a template supports.

The «source» can be

path/
    the path to a local directory tree containing the template

git https://path/to/git/repo
git https://path/to/git/repo branch git_branch
git https://path/to/git/repo tag git_tag
git https://path/to/git/repo ref git_ref
    install from a git repository

github user/project
github user/project branch git_branch
github user/project tag git_tag
github user/project ref git_ref
    install from github from the given user and project

hex hex_package
hex hex_package 1.2.3
    install from a hex package. Use mix template.hex to find
    available packages.

Templates are installed in $MIX_HOME/templates (by default ~/.mix/templates).

See

Details for each individual task can be found using mix help template, mix help tmplate.hex and so on.

See Mix.Tasks.Gen (in project :mix_generator) for details of how to use these templates.

License

Apache 2.0. See LICENSE.md for details.

See also

For information on writing your own templates, see the moduledoc for MixTemplates, also in this package.

mix_templates's People

Contributors

pragdave avatar producture avatar aforward avatar mbramson 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.