Giter Site home page Giter Site logo

Concatenate sections about styledown HOT 2 CLOSED

styledown avatar styledown commented on September 26, 2024
Concatenate sections

from styledown.

Comments (2)

nickisnoble avatar nickisnoble commented on September 26, 2024

I tend to write all my docs for a section at the top of the file. (I'm using scss, so in this case it would be something like _buttons.scss.

Then my example block would look something like this:

@example
a.button This is a button
a.button.primary This is an action button
a.button.secondary This is a secondary action button
a.button.cancel This is a cancel button

It will all render ok even if the styles come later or in a different file, because the output is static (so it uses the whole stylesheet(s) anyway, so long as it/they are included in config.md).


Otherwise, if you generate your documentation from a Markdown file rather than css comments, you can have them all in one section. I like doing it this way, having the docs be separate is a little better for organization, and my team likes it because they can edit the copy, if need be, without dealing with real code.

from styledown.

SammyM avatar SammyM commented on September 26, 2024

Okay, thank you.

from styledown.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.