muffinresearch/cog-style-guide

COG static, living styleguide generator

cog-style-guide's Issues

Being able to order pages could be nice

I can imagine both wanting to group collections of pages (use dirs?) or just simply order pages in a different order to how they naturally appear based on the iteraction over the .md files in the dir.

Make paths relative in cog's HTML templates

Currently the paths are expressed from / which means:

• Direct viewing of the output in a browser breaks
• GH pages which are access by a path e.g. mozilla.github.io/foo/ won't work.

Add more tests

The builder needs a lot more tests to cover everything it does.

Allow a default starting resolution for the resizable iframe.

This will allow a desktop only page to start in the correct size.

Add categorization

I can see a need to categorize the pages in the styleguide so instead of a nav that's a flat list like so:

• Index
• Page 1
• Page 2

You can have:

Index

Examples

• Example 1
• Example 2

Views

• Login View
• Error Page

Doing this could be based on putting the markdown in dirs. This way the dirs could inform the categories. Underscores and hyphens could be converted to spaces in the titles.

If nesting is used the lookup of templates / config files should at the following paths in order:

1. dir/[baseName][ext]
2. [baseName][ext]

So you can optionally nest everything or just the markdown. This would also then mean you can have the same baseName in multiple places if you really wanted to.

Make it easier to override the template function.

Currently there's a single template render function. This can be overridden but this would then mean you'd be overriding the renderer for cog as well as the renderer for the iframed templates.

For most use-cases if a different template system is required it's going to just be a case of changing the iframe generation template renderer. Let's make that easier.