Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 2.62 KB

introduction.md

File metadata and controls

62 lines (44 loc) · 2.62 KB
Raw

Introduction

Thanks for using Undernet! Hit the ground running in your next project with this fully modular, highly configurable front-end framework.

Undernet is extremely light, carrying no external dependencies apart from needing a SCSS compiler (if you aren't using the compiled CSS).

Get Started

The quickest way to use Undernet is to link the bundled js and minified css directly in your template.

<!DOCTYPE html>
<html>
  <head>
    <title>I'm using Undernet!</title>
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <link rel="stylesheet" href="path/to/undernet.min.css">
    <!-- Add new styles after -->
  </head>
  <body>
    ...
    <script type="text/javascript" src="path/to/undernet.bundle.min.js" async></script>
    <script type="text/javascript">
      document.addEventListener('DOMContentLoaded', Undernet.start())
    </script>
  </body>
</html>

Head over to the download page to get Undernet's assets, or see other options for including it in your pipeline.

About Undernet

Undernet was created with the goal of simplifying the developer experience, by writing less CSS and giving an easy JavaScript API for using common interactive UI patterns.

Undernet can both be a prototyping tool or the basis for your web app.

Core Principles

  • Configuration: The framework comes with a configuration file that you can update with your intended brand attributes, including colors, typography, grid, forms, and more.
  • Semantics: If markup is required, it's logical and written with accessibility in mind.
  • Modularity: Can act independent from your core stylesheet; the framework is specifically designed to be scoped and controlled as an alternative, to existing projects.
  • Agility: Because all that's needed is an understanding of semantic HTML (and possibly SCSS), you will quickly get to developing without worrying about tons of custom styling/javascript.

Support

Undernet's CSS and JavaScript will work in recent versions of these browsers:

  • Chrome ✓
  • Firefox ✓
  • Safari ✓
  • Opera ✓
  • MS Edge ✓
  • IE 11 ✓

Contribute

Undernet is completely open source!

Contribute on Github if you have questions or a want to file a bug report. Be sure to read about contributing before filing a bug or pull request.

Is this article inaccurate? Edit this page on Github!