A starting point for crafting living style guides. You can clone, fork, or download the repo from GitHub. Once you have the files for Style Guide Boilerplate, you'll create a directory on your site for them. Style Guide Boilerplate is currently PHP based so you will need a server that supports PHP. Upload the files from the GitHub repo to your newly created directory. In the head of Style Guide Boilerplate are custom styles for the boilerplate itself. These have all been prefixed with sg- so they hopefully shouldn't cause any conflicts with your website's own styles. You should be able to go to yoursite.com/style-guide/ and see how your live site's CSS affects base elements. The last step is creating your site's custom patterns/modules. To create custom patterns like buttons, breadcrumbs, alert messages, etc., create a new .html file and add your HTML markup into the file.

Features

  • Generate static HTML style guide
  • Create personalized documentation
  • Create custom patterns
  • Review your live site CSS
  • Upload the Style Guide Boilerplate files
  • Hook up your own CSS into the style guide
  • Download the Style Guide Boilerplate

Project Samples

Project Activity

See All Activity >

License

MIT License

Follow Style-Guide-Boilerplate

Style-Guide-Boilerplate Web Site

You Might Also Like
MongoDB Atlas runs apps anywhere Icon
MongoDB Atlas runs apps anywhere

Deploy in 115+ regions with the modern database for every enterprise.

MongoDB Atlas gives you the freedom to build and run modern applications anywhere—across AWS, Azure, and Google Cloud. With global availability in over 115 regions, Atlas lets you deploy close to your users, meet compliance needs, and scale with confidence across any geography.
Start Free
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of Style-Guide-Boilerplate!

Additional Project Details

Programming Language

PHP

Related Categories

PHP HTML XHTML, PHP Documentation Software

Registered

2023-04-21