Code Monkey home page Code Monkey logo

crayon's Introduction

crayon ๐Ÿ˜Ž

a local development setup for styling your CodePen profile

The problem

Did you know that you can style your CodePen profile? You can!

It's simple. In your profile settings, you can apply the CSS from any pen to your profile by providing the URL in the options within "Settings > Customize".

https://codepen.io/<YOUR USERNAME>/settings/customize

However, that's easier said than done. You'll need to explore the markup and work out the styles you want to overwrite. This in addition to working on the styling pen whilst constantly refreshing your profile page to review the changes ๐Ÿ˜– ๐Ÿ˜ด

The solution

This repo reduces the burden by allowing you to work with a local and generic version of a CodePen profile page. You're able to review your developed styling and get visual feedback in the browser with live reload goodness ๐Ÿ˜„ Once you're done, you can deploy the styling changes to CodePen from the command line using an automated "POST to Prefill Editors" setup.

Usage

The repo uses a Makefile to process the source and deploy styles to CodePen.

To get started;

make setup

You can then use

make develop

to get underway with developing your styles.

Style source is located within src/style. The main point of entry being src/style/style.styl. The repo uses Stylus as I find this to be a relatively flexible preprocessor that allows various syntax styles and should keep the majority happy.

Once you're happy with your styles, you can deploy them.

make deploy

NOTE:: For deployment to work seamlessly, it is assumed you are on OSX and your default application for handling .html files is a browser and not an editor. If this is not the case, simply open tmp/deploy-template.html in the browser of your choice.

This will create a new pen in your browser containing your styling. Once this pen is saved, all that is left to do is linking it to your profile at https://codepen.io/<YOUR USERNAME>/settings/customize.

Enjoy! ๐Ÿ˜Ž

Examples

  • Your own styles?

Contributing

Any issues or suggestions, feel free to open an issue or submit a PR. Alternatively, you can tweet me @_jh3y

It would also be great if people could share their own styles/creativity to gather a curated list of example styles.

Made with โค๏ธ by @jh3y 2016

crayon's People

Contributors

jh3y avatar

Stargazers

Shashi Kumar Nagulakonda avatar

Watchers

James Cloos avatar Alex Zaworski avatar  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.