Code Monkey home page Code Monkey logo

atomic-docs's Introduction

Atomic Docs

Atomic Docs is a front end style guide generator and component manager. Atomic Docs is built in PHP and Sass. Inspired by Brad Frost's Atomic Design principles.

Atomic Docs works with Sass, Less and Stylus.

Documentation can be found at AtomicDocs.io.

atomic docs gif

##Set up

  1. Download Atomic Docs and add to your local PHP environment.
  2. Configure your preprocessor to output scss/main.scss to css/main.css.
  3. Go to http://localhost/atomic-docs/atomic-core/index.php and get started.

##Document Have full documentation to hand off to other teams, internal or external.

##Edit in the Browser Edit your components directly in the browser using the Ace.js editor.

##Organize Organize all your components under categories that you name. "Base", "Modules", "Atoms" etc...

##Manage Manage all your components. Move, rename and delete with a clean GUI interface.

##Save time Does all the "wiring" of your SCSS partials. Never write @import "partial-name"; again.

Documentation can be found at AtomicDocs.io.

##Join the conversation! We'd love to hear your thoughts and suggestions. Join us on Slack.

atomic-docs's People

Contributors

devineir avatar dnicolson avatar kittygiraudel avatar mdahlke avatar nick-wisnet avatar nickberens360 avatar nicoqh avatar rafaellyra avatar

Watchers

 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.