Git Product home page Git Product logo

titlex's Introduction

Title

Hex.pm Version CI Status

Title is a library that aims at capitalizing your titles in a simplified manner. There are a couple of different styles, but they don't differ much. If you do have a preference check out the available styles in Title.Opts.

You can easily pass in some of your own custom words. These are words for which you have your own custom casing. This can also be used to extend the library with abbreviations since they're not (yet?) part of this library. Same goes for names, though many names fall under the default category to be capitalized.

Examples

iex> Title.capitalize("`Title` is a library that aims at capitalizing your titles in a simplified manner")
"`Title` Is a Library That Aims at Capitalizing Your Titles in a Simplified Manner"

iex> Title.capitalize("You can easily pass in some of your own 'custom' words", custom: ["CUSTOM"])
"You Can Easily Pass in Some of Your Own 'CUSTOM' Words"

iex> Title.capitalize("The default style has *underneath* capitalized")
"The Default Style Has *Underneath* Capitalized"

iex> Title.capitalize("The chicago style has *underneath* NOT capitalized", style: :chicago)
"The Chicago Style Has *underneath* Not Capitalized"

iex> Title.capitalized?("Is My Title Properly Capitalized?")
true

Installation

The package can be installed by adding titlex to your list of dependencies in mix.exs:

def deps do
  [
    {:titlex, "~> 0.1.0"}
  ]
end

Documentation can be found at https://hexdocs.pm/titlex.

Credits

titlex's People

Contributors

tverlaan avatar

Stargazers

 avatar

Watchers

 avatar  avatar

titlex's Issues

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.