Skip to content

Latest commit

 

History

History
81 lines (67 loc) · 3.2 KB

index.md

File metadata and controls

81 lines (67 loc) · 3.2 KB
layout title
home
Release the docs!
SassDoc, release the docs!
        <div class="megatron__content">

{% highlight bash %}

Install SassDoc globally

npm install sassdoc -g

Run SassDoc on your project

sassdoc source/ {% endhighlight %}

<div class="megatron__bottom">
    <div class="container">
        <div class="megatron__content">
            <a href="{{ site.baseurl }}/getting-started/" class="button  button--primary  megatron__button">Documentation</a><!--
            --><a href="http://twitter.com/share?text=Release+the+docs!+@SassDoc_+is+a+documentation+tool+for+Sass+%E2%80%94&url=http://sassdoc.com" class="button  button--primary  megatron__button" target="_blank">Tweet it</a>
        </div>
    </div>
</div>
    <p class="home__note">Already using SassDoc? <a href="{{ site.baseurl }}/upgrading/">Upgrade to version 2</a> right away!</p>

    <p>SassDoc is to Sass what JSDoc is to JavaScript: a documentation system to build pretty and powerful docs in the blink of an eye. Among other things, SassDoc is:</p>

    <ul>
        <li>usable out of the box;</li>
        <li>highly customisable;</li>
        <li>blazingly fast;</li>
        <li>fully themable;</li>
        <li>integrated with Grunt/Gulp/Broccoli or directly Node.</li>
    </ul>
</div>

How it works

        <p><a href="http://github.com/sassdoc/sassdoc">SassDoc</a> parses your source folder to grab <a href="{{ site.data.routes.annotations }}">documentation-specific comments</a>. From there, it builds a <a href="{{ site.data.routes.data_interface }}">data tree</a>, that gets <a href="{{ site.data.routes.extra_tools }}">enhanced and filtered</a> before being passed to the <a href="{{ site.data.routes.view }}">view</a>. So you end up with a fully styled HTML document, like this:</p>

        <a href="{{ site.baseurl }}/theme-gallery/preview/default/"><img src="{{ site.baseurl }}/assets/images/preview-image.png" alt="SassDoc Default Theme" /></a>
    </div>
</div>

What they say

{% include quotes.html %}

All these projects are documented with SassDoc. What are you waiting for?

    <a href="{{ site.baseurl }}/getting-started/" class="button  button--primary  megatron__button">Get started</a>
</div>