Comments (2)
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.
Okay, thank you.
from styledown.
Related Issues (20)
- Css components order HOT 2
- Navigation feature HOT 10
- Api problem when passing list of files
- Space after inline elements removed HOT 3
- Option to use Sass Comment Style HOT 13
- Styledown.parse([Array]) fails to process CSS files that come after the first .md filej.
- Couldn't run it on Windows HOT 2
- Markdown config not working as expected for HTML inline comments HOT 1
- Styledown failes to proccess css example into html HOT 2
- Styledown: Command Not Found HOT 7
- html attributes in styledown comments HOT 2
- can't run syledown HOT 2
- Adding a Basic Markdown page. HOT 1
- Image source in inline css comment HOT 1
- Using comments, strange 'closing bracket' appears
- Use `node-glob` to properly cross-platform expand globbing syntax
- Jade has been deprecated, upgrade to Pug?
- ENOENT: no such file or directory HOT 1
- -bash: styledown: command not found HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from styledown.