https://github.com/nickberens360/atomic-docs

Front end code documentation generator. http://atomicdocs.io/
https://github.com/nickberens360/atomic-docs

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/nickberens360/atomic-docs
• Owner: nickberens360
• License: gpl-3.0
• Archived: true
• Created: 2014-08-14T20:32:15.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T00:32:01.000Z (over 1 year ago)
• Last Synced: 2024-06-12T15:06:08.271Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 59.1 MB
• Stars: 782
• Watchers: 37
• Forks: 92
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - atomic-docs - Front end code documentation generator. http://atomicdocs.io/ (JavaScript)

README

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



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