Name: academy-website-styleguide
Owner: BBC
Description: Academy front end styleguide
Created: 2017-11-06 15:04:08.0
Updated: 2018-05-01 09:19:59.0
Pushed: 2017-11-08 15:12:50.0
Size: 47327
Language: HTML
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Cortana is a nice theme for Trulia's Hologram, the ruby front-end doc generator, and inspired by PebbleRoad's Tapestry.
Check the Demo
To install the last version of Hologram (required) :
m install hologram
To install Cortana, use Bower :
wer install --save-dev Cortana
Your hologram_config.yml should look like :
rectory to parse
ce: ./your-code
rectory to build the styleguide
ination: ./styleguide
logram theme
mentation_assets: ./bower_components/Cortana
om_markdown: ./bower_components/Cortana/CortanaMarkdownRenderer.rb
have a custom index page build with your README.md
x: README
st all css to include for the styleguide render examples (path from styleguide directory)
include:
'../assets/css/vendors.css'
'../assets/css/styles.css'
st all js to include for the styleguide render examples (path from styleguide directory)
nclude:
'http://code.jquery.com/jquery-1.10.2.min.js'
'../assets/js/main.js'
ring who is used to split the category name and create category wrapper
_scope: ' - '
We recomand to place a README.md in the root of your source directory to build a custom styleguide index page.
To have add a custom category wrapper like in the example, just add it before your category name with space-space and before all the other categories in the same wrapper. This name_scope can be change in the hologram_config.yml. You will have something like this :
c
e: My Title
: myname
gory: General - Button
Markdown comment and markup...
To edit Cortana you will need Bower, npm and NodeJS
To setup the project :
m install
wer install
lp