Skip to content

sourcejs/Source

Repository files navigation

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:

image

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     FAQ     Use Cases


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.

Things that SourceJS is NOT

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 files (index.src by default), where you leave your HTML examples, template calls and description. All Specs are located in sourcejs/user/specs folder, and could contain any catalogue structure, with focus on component folders.

But engine will support DSS as a plugin, which is universal CSS Documentation parser. So it will be possible to document your components both in CSS, Markdown and native index.src.

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

Upcoming updates

  • DSS support
  • Full Markdown support within component/index.md and component/readme.md
  • Support of multiple documentation projects in one environment
  • GitHub Authorization for personalizing user actions, group management and notifications
  • Screencasts and engine usage demos
  • Full english documentation stack for core API
  • Test coverage
  • Stable v1.0.0 version

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.

About

[ON HOLD] Living Style Guides Engine and Maintenance Environment for Front-end Components. Core repository.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 15