Skip to content

nickberens360/atomic-site

Repository files navigation

Welcome!

Atomic Docs is made for styleguide driven development.

Requirements: A local PHP enviornment. And a CSS preprocessor.

<ol class="docBlock-ul">
	<li>Set up your CSS preprocessor of choice. As expected we will be processing from our SCSS directory to the CSS directory.</li>
	<li>Go to: localhost/atomic-docs/atomic-core/index.php</li>
	<li>In the lower left hand corner, open the "Manage Categories" form. In the create category field we will create a new component category. In a nod to <a href="http://atomicdesign.bradfrost.com/"> Brad Frost</a>, I'll call this one "molecules".
	<br/><br/>
		<img class="docBlock-img" src="atomic-core/img/doc1.png" width="250" />
	<br/><br/>
	</li>
	<li>Click on the newly created molecules link in the sidebar to go to the molecules page. In the form below the molecules link let's create a new component called "calloutBox".
	<br/><br/>
		<img class="docBlock-img" src="atomic-core/img/doc2.png" width="250" />
		<br/><br/>
	</li>
	<li>So next we'll create the HTML for the calloutBox component. In the project directory you'll notice a folder named "compontents". Open that and you'll find the folder molecules. This is the directory that all of the HTML component files you create under the molecules category will be located. Let's open the file "calloutBox.php" and put some HTML code there.
	<br/><br/>
        <img class="docBlock-img" src="atomic-core/img/doc3.png" width="250" />
        <br/><br/>
	</li>
	<li>Back in our projects directory open up the SCSS folder. You will see the folder molecules and within molecules is the the newly created _calloutBox.scss file. This of course is where we'll put our styles for the calloutBox component. As a side note, atomic-docs handles wiring up all of the scss "@import" strings. Even if I'm not creating a style guide this feature is sooo time saving.
	<br/><br/>
       <img class="docBlock-img" src="atomic-core/img/doc4.png" width="250" />
       <br/><br/>
	</li>
	<li>Now back to our project in the browser. Click on the molecules link in the sidebar and you'll see our newly created component.
	<br/><br/>
        <img class="docBlock-img docBlock-img__big" src="atomic-core/img/doc5.png" width="250" />
        <br/><br/>
	</li>
	<li>And that's it!</li>
</ol>

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published