search

trulia / hologram

A markdown based documentation system for style guides.
http://trulia.github.io/hologram
Other
2.16k stars 199 forks source link

How to doc colors #248

Open wachri opened 8 years ago

wachri commented 8 years ago

I found a very nice example in the Cortana demo under http://yago.github.io/Cortana-example/layout_-_colors.html. I searched around but found no where an example how to generate this.

lawren commented 8 years ago

You can use normal markup in markdown. Just build out your palette with HTML within the doc section and it should render appropriately.

Be sure to add a none-example to the end of your doc section if you aren't using any other examples. That way the cortana renderer won't trip up with it's conversion process.

ghost commented 8 years ago

Hey lawren ,

I have tried to show the basic color of my web application in my style guide like http://yago.github.io/Cortana-example/layout_-_colors.html.I have written the doc as layout_colors.txt .It's showing only the HTML code but not showing the Example. Could you please help me..

lawren commented 8 years ago

@ParhiBijayini

Try this instead: gist

The html you want to actually render as-is shouldn't be wrapped as an example, just raw. Then, to appease the parser, you have to place a none_example in the bottom.