Skip to content

My fork of Nick Berens Atomic Docs front end code documentation generator. http://atomicdocs.io/

Notifications You must be signed in to change notification settings

webstractions/atomic-docs

 
 

Repository files navigation

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.

Documentaion 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 documentaion to hand off to other teams, internal or external.

##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.

Documentaion can be found at AtomicDocs.io

About

My fork of Nick Berens Atomic Docs front end code documentation generator. http://atomicdocs.io/

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 74.9%
  • CSS 22.5%
  • PHP 2.6%