/atomic-docs

Front end code documentation generator. http://atomicdocs.io/

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Atomic Docs

Atomic Docs started as an internal tool and has been pieced together over the years often without best development practices in mind. Since there seems to be interest in Atomic Docs I will be refactoring the code. I am currently looking for PHP dev contributors to help in this process as my development skills are mainly frontend.

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.

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