jesprider/source

Living Style Guide Engine and Maintenance Environment for Front-end Components. Core repository.

SourceJS - Living Style Guide Platform

The most advanced tool for documenting, testing and managing Front-end Components achieving productive team work.

SourceJS powered workflow allows developers to code new components directly in the documentation. Combining web components development with documentation and team communication processes, makes SourceJS a powerful tool for Front-end developers and designers.

Check out short video overview:

Our main goal is to provide flexible, modular environment for managing reusable Front-end components library. We don't focus on specific technologies, allowing to seamlessly integrate SourceJS workflow with your existing codebase.

---

Source engine project page     Documentation     Quick Start     Examples    How-to's

---

SourceJS component management engine was originally developed in OK.ru front-end development team and is recommended for big and middle sized projects. Especially for fast growing web portals, outsource teams with similar project and companies with multiple services.

Materials for presentations.

SourceJS is NOT

To clear some confusion around Living Style Guide Platforms comparison, let us define few main differences.

Static site builder

SourceJS is a dynamic Node.js application, and does not build static website as Pattern Lab, KSS, StyleDocco are doing. Dynamic environment allows to connect unlimited number of plugins and middlewares for compiling docs, styles, text right on the flight.

CSS Documentation parser

Engine is based on gathering special documentation templates (index.src, readme.md and others), where you leave your HTML examples, template includes and description. All Specs are located in sourcejs/user/specs folder, and could contain any catalogue structure, with focus on component folders.

But you can use official SourceJS plugin based on DSS, CSS Documentation parser - https://github.com/sourcejs/sourcejs-contrib-dss.

Join the community

Many teams are already using SourceJS for building and managing Front-end components libraries for themselves and their clients. To join the community, you just need to follow few simple rules - check our docs about Maintaining and Contribution.

If you notice some bugs, or need to help finding a better solution in your process, feel free to create an issue, and we will solve your problem together.

Updates

• 28.03.15 0.5.1 patch release with EJS pre-rendering and various bugfixes
• 28.03.15. SourceJS Bootstrap example bundle and How-to articles blog
• 15.03.15. New example Specs showcase (source code)
• 15.03.15. CSS Documentation support with SourceJS DSS plugin
• 12.03.15. 0.5.0 release with full Markdown support, GitHub auth, info.json watchers and other improvements
• 24.02.15. 0.4.1 patch release
• 05.02.15. Mentioned at in-depth Style Guides Tools overview talk
• 18.01.15. Published an intro video about SourceJS
• 07.01.15. 0.4.0 stable release. From now, we move to fast, semantic release cycle. No globally breaking changes till 1.0.0
• 08.10.14. 0.4.0-rc release, migration instructions
• 01.08.14. Video review of SourceJS engine and workflow example (RU with EN subtitles)
• 31.07.14. 0.4.0-beta release
• 01.05.14. Engine presentation from Front-end Ops Conf, San Francisco - Taking Development Tools To The Next Level with video
• 31.01.14. Preview of Source companion tool for prototyping interfaces using existing components
• 31.12.13. 0.3.2 release
• 09.10.13. Engine presentation on Fronteers Jam (video)
• 23.09.13. Published video recording of Source engine presentation from RIT++ 2013 (RU)

Upcoming updates

Respecting open source community, we track all our tasks publicly on GitHub. Follow our milestones and twitter announcements @SourceJS to keep in sync with latest plans.

List of few global upcoming features

• Refactored code snippets API
• Integrations with JSDoc and drop-in replacement setup for other Style Guide tools like KSS/Pattern Lab
• More screencasts and engine usage demos
• Wider support of multiple documentation projects in one environment
• Full documentation stack for core API for writing plugins

SourceJS follows semantic versioning and we do our best to keep as less breaking changes as possible.

Preparing to 1.0 release, we plan to keep migration path very smooth and painless. So if you will keep in sync with minor releases and API deprecation announcements, you won't face any problems setting up major release updates.

Useful information

Browser support

SourceJS client-side part is supported in all latest major browsers and IE8+ in Clarify for testing components.

---

Copyright © 2013-2015 SourceJS

Licensed under MIT License, read more at license page.