faucet-pipeline / aiur

a simple styleguide generator

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Simplified configuration format

FND opened this issue · comments

commented

As discussed elsewhere, this doesn't scan too well IMO:

[{
	"slug": "",
	"file": "./components/welcome.md"
}, {
	"slug": "atoms",
	"file": "./components/atoms.md",
	"children": [{
		"slug": "button",
		"file": "./components/button/doc.md"
	}, {
		"slug": "strong",
		"file": "./components/strong/doc.md"
	}]
}]

This seems significantly less noisy:

{
	"": "./components/welcome.md",
	atoms: {
		file: "./components/atoms.md",
		children: {
			button: "./components/button/doc.md",
			strong: "./components/strong/doc.md"
		}
	}
}

JavaScript instead of JSON would additionally cut down on " noise, but that might be optional.

I'll probably whip up a PR soon-ish.

This is done 👍