Livingstyleguide Versions Save

Easily create front-end style guides with Markdown and Sass/SCSS.

v2.0.1

7 years ago

This release solves several warnings especially released to recent Sprockets and Rails versions.

v2.0.0.pre.4

7 years ago

This release fixed all open bugs for 2.0.0. If no further bugs will be found, this should be equal to the final 2.0.0 release. If you find a bug, feel free to open an issue.

Changes

  • Adds a shortcut @scss !global for @scss scope: global
  • Fixed/improved Sass imports (#191)
  • Refactored classes and variables
  • Removed IE hack
  • Fixes duplicate imports (#198)
  • Fixes duplicate colors Sass error (#196)
  • Internal:
    • Cleaned up the code base

If you have been using LSG2 < 2.0.0.pre.4:

v2.0.0.pre.1

7 years ago
  • Optimized default theme
  • Optimized defaults for colors and sizes
  • Removed Alt + click for copying colors as it raised problems for Linux users (now: click on either the value or the variable/function to copy; this also avoids having English text which would require localization)
  • @require respects the current path for loading Ruby files
  • Commands can be escaped with trailing \ (for example if you want to document LSG itself)
  • Color swatches show the source only when the source already is a color (instead of a Sass variable/function)

v2.0.0.pre.2

7 years ago
  • Color swatches accept nested functions like lighten($my-color) from now on
  • Doesn’t autofocus the search box (avoids scrolling up when refreshing the page)

v2.0.0.pre.3

7 years ago
  • CSS/Sass code can be added to the global scope from now on
  • Internal:
    • Color swatches have been refactored for reduced error-proneness

v1.4.0

7 years ago
  • #188: Sprockets compatibility
  • Internal:
    • Added Ruby 2.3.0 to Travis CI
    • Fixed Travis CI bundler issue

v1.3.0

7 years ago
  • #185: Better responsiveness for style guides
  • #184: Resolved issue where compiling via CLI would be stuck in a while loop if no GemFile or .git directory exists.
  • #175: Allow variables with underscore
  • #161: Updated RedCarpet version

v2.0.0.alpha.11

8 years ago

What’s new in v2.0.0.alpha.11?

Other features:

  • The before and after commands in which you can introduce other commands, HTML or text.

    @before:
<div> this-is a before example </div>  

@after:
<div> this-is an after example </div>

  • In this version the command @search-box is included inside of the document’s before section

  • The toggle-code button it is added via the @toggle-code command and it allows you to show or hide the code blocks that appear under the code examples. It is included inside of the document’s before section.

This version include some general improvements:

  • Rename filters to commands which reflects their usage and will allow filtering later.

  • The style of code is unified (changing the single quotes for double quotes), and the obsolete files of the V1 were removed.

  • Add helper for rendering templates, when you want to use an ERB template, You won’t need to use:

    ERB.new(File.read("#{File.dirname(__FILE__)}/../templates/<name_file>")).result(binding)

    Anymore, now it will be enough with:

      LivingStyleGuide.template("<file_name>", binding)

  • Reorganize JavaScript scripts and use new javascript instance variable to hold them into the LivingStyleGuide::Document.

    All JavaScript scripts now live under templates/scripts as *.js.erb files.

  • Now running the tests will be faster and easier, avoiding warnings while executing them.

  • Add a linter for SCSS and integrate with Hound CI.

  • In this new version all the test are green.

Working features:

  • It works well in Rails 4/Tilt
  • New command syntax everywhere (as it used to be within examples: Now everywhere in the file and the root document)
  • Importing (@import coding-style.lsg) of other files (LivingStyleGuide documents, HTML, Haml, …)
  • Imported files can be rendered with local data defined as JSON
  • Importing supports globbing of files
  • Having multiple LivingStyleGuide documents by sharing the configuration and loading it via@import config.lsg) (requested by @ronaldlokers and others in #57)
  • All imported files and all code examples will be grouped in a
    with unique ID (as ID the current file name will be used if available). This helps scoping CSS and allows linking.
  • No need to import/parse/render the whole Sass project (only color variables may be needed) (requested by @indieveed in #97)
  • Sprockets dependencies (except imports within Sass)
  • Colors do support Sass functions(), #hex, and colorconstants besides $variables(requested by @scottdavis in https://github.com/livingstyleguide/livingstyleguide-concept/issues/1)
  • SCSS code can be added everywhere when needed (within examples, it will be automatically scoped to this example)
  • JavaScript/CoffeeScript filters
  • Command line interface
  • Highlights within code (*** ... ***)
  • Handle the root directory of a project and allow relative paths
  • Asset URLs and helpers
  • Cache invalidation for Sprockets when Sass files change
  • HTML title
  • Requiring of Ruby files or Gems
  • Colors/style configuration
  • Header/footer HTML
  • JavaScript imports
  • Head HTML
  • Sass syntax support within documents (linking *.sass files work as expected)
  • Set default type

v2.0.0.alpha.10

8 years ago

What’s new in v2.0.0.alpha.10?

This alpha version includes two more contributions by LSG’s Rails Girls Summer of Code team, Fanxhe: Now you can copy code from the examples and search the style guide.

Other features

  • Inline search in the style guide via @search-box (RGSoC)

  • allow commands inside of command blocks:

    @header
  @haml
  .my-header My Header

  • @default type: xyz now also applies for code examples

     @default type: haml

 ```
 .this-is an Haml example
 ```

 @header
   .my-header My Header

  • Ugly scrollbars on code are hidden by default now

  • Code examples also got a copy button (RGSoC)

  • Added viewport for mobile view

  • Fixed escaping of IDs in CSS

If you have been using LSG2 < 2.0.0.alpha.10:

  • It should not require changes. Except for the mobile view if you had a custom solution.

WARNING

This is an alpha version:

  • Not all tests are green
  • Things might change and be incompatible with following alpha or pre releases.

As the documentation is not done yet, most of the features in the following list will link to the test cases.

The planned features for v2 can also be found in this dummy project—including the v1 structure for comparison: https://github.com/livingstyleguide/livingstyleguide-concept

Feedback is welcome! Please follow @LSGorg for updates. Tweet about it using #LSG2!

Working features:

  • It works well in Rails 4/Tilt
  • New filter syntax everywhere (as it used to be within examples: Now everywhere in the file and the root document)
  • Importing (@import coding-style.lsg) of other files (LivingStyleGuide documents, HTML, Haml, …)
  • Imported files can be rendered with local data defined as JSON
  • Importing supports globbing of files
  • Having multiple LivingStyleGuide documents by sharing the configuration and loading it via @import config.lsg) (requested by @ronaldlokers and others in #57)
  • All imported files and all code examples will be grouped in a <section> with unique ID (as ID the current file name will be used if available). This helps scoping CSS and allows linking.
  • No need to import/parse/render the whole Sass project (only color variables may be needed) (requested by @indieveed in #97)
  • Sprockets dependencies (except imports within Sass)
  • Colors do support Sass functions(), #hex, and colorconstants besides $variables (requested by @scottdavis in https://github.com/livingstyleguide/livingstyleguide-concept/issues/1)
  • SCSS code can be added everywhere when needed (within examples, it will be automatically scoped to this example)
  • JavaScript/CoffeeScript filters
  • Command line interface
  • Highlights within code (*** ... ***)
  • Handle the root directory of a project and allow relative paths
  • Asset URLs and helpers
  • Cache invalidation for Sprockets when Sass files change
  • HTML title
  • Requiring of Ruby files or Gems
  • Colors/style configuration
  • Header/footer HTML
  • JavaScript imports
  • Head HTML
  • Sass syntax support within documents (linking *.sass files work as expected)
  • Set default type

Features of v1 which have not completely been upgraded:

  • Automatically import Markdown/LSG files by Sass imports
  • Parsing color variables out of a Sass file

Features that should be part of v2 but are not done yet:

  • Extend command line interface to accept directories (= render all *.lsg within that directory)
  • Convert v1 YAML files into v2 LSG files via command line

v2.0.0.alpha.9

8 years ago

What’s new in v2.0.0.alpha.9?

This alpha version includes the first contribution by LSG’s Rails Girls Summer of Code team, Fanxhe. Now, clicking on color swatches copies the variable name and alt+clicking copies the hex-code.

click-to-copy

Other features

  • Better IDs generated by file name and headline
  • CSS class names and Sass variables are prefixed with lsg-- from now on (was livingstyleguide--)
  • Split up CSS commands into @css, @sass and @scss

Details and documentation on those new features can be found in the Readme file.

If you have been using LSG2 < 2.0.0.alpha.9:

  • You need to update the use of @css:
    • Use @css for adding plain CSS or importing a CSS file (@css my-styles.css)
    • Use @scss for adding SCSS or importing a SCSS file (@css my-styles.scss)
    • Use @sass for adding Sass or importing a Sass file (@css my-styles.sass)
  • You need to rewrite all variables (if you have been using any) from $livingstyleguide--variable-name to $lsg--variable-name
  • You need to rewrite all classes (if you have been using any) from .livingstyleguide--class to .lsg--class

Ruby Versions:

  • Ruby < 2.0.0 has been deprecated
  • Ruby 2.2.0 in combination with Haml might have troubles

WARNING

This is an alpha version:

  • Not all tests are green
  • Things might change and be incompatible with following alpha or pre releases.

As the documentation is not done yet, most of the features in the following list will link to the test cases.

The planned features for v2 can also be found in this dummy project—including the v1 structure for comparison: https://github.com/livingstyleguide/livingstyleguide-concept

Feedback is welcome! Please follow @LSGorg for updates. Tweet about it using #LSG2!

Working features:

  • It works well in Rails 4/Tilt
  • New filter syntax everywhere (as it used to be within examples: Now everywhere in the file and the root document)
  • Importing (@import coding-style.lsg) of other files (LivingStyleGuide documents, HTML, Haml, …)
  • Imported files can be rendered with local data defined as JSON
  • Importing supports globbing of files
  • Having multiple LivingStyleGuide documents by sharing the configuration and loading it via @import config.lsg) (requested by @ronaldlokers and others in #57)
  • All imported files and all code examples will be grouped in a <section> with unique ID (as ID the current file name will be used if available). This helps scoping CSS and allows linking.
  • No need to import/parse/render the whole Sass project (only color variables may be needed) (requested by @indieveed in #97)
  • Sprockets dependencies (except imports within Sass)
  • Colors do support Sass functions(), #hex, and colorconstants besides $variables (requested by @scottdavis in https://github.com/livingstyleguide/livingstyleguide-concept/issues/1)
  • SCSS code can be added everywhere when needed (within examples, it will be automatically scoped to this example)
  • JavaScript/CoffeeScript filters
  • Command line interface
  • Highlights within code (*** ... ***)
  • Handle the root directory of a project and allow relative paths
  • Asset URLs and helpers
  • Cache invalidation for Sprockets when Sass files change
  • HTML title
  • Requiring of Ruby files or Gems
  • Colors/style configuration
  • Header/footer HTML
  • JavaScript imports
  • Head HTML
  • Sass syntax support within documents (linking *.sass files work as expected)

Features of v1 which have not completely been upgraded:

  • Automatically import Markdown/LSG files by Sass imports
  • Parsing color variables out of a Sass file

Features that should be part of v2 but are not done yet:

  • Extend command line interface to accept directories (= render all *.lsg within that directory)
  • Convert v1 YAML files into v2 LSG files via command line