Code Monkey home page Code Monkey logo

amber-website's Introduction

amber-website

Build Status https://david-dm.org/bitrockteam/amber-website.svg

./logo/logo-horizontal.svg

Docs & guides for the Amber Design System, based on the VuePress static site generator.

Amber Design System

Development

Getting started

Clone the repo

$ git clone [email protected]:bitrockteam/amber-website.git && cd amber-website

Install dependencies

$ yarn
--- or ---
$ npm install

Available NPM tasks

Start the project in development mode (live reload)

$ yarn start

Create a static build in the ./dist folder

$ yarn build

How to contribute

Please refer to our contributing document.

License

Website developed by Bitrock UI Engineering team, released under the MIT license, the Amber Design System logo is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

Bitrock s.r.l is part of Databiz Group.

amber-website's People

Contributors

alessandromenini avatar anthonypenna avatar asm72 avatar francescopellegrini avatar kaseyhinton avatar moebiusmania avatar vadimbakaev avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

amber-website's Issues

Changelog section

A page under the resources section that loads dynamically the release's feeds of both amber-components and amber-visual repos and displays the data as a unified list of updates.

logo

Find a nice looking logo for Amber Design System...

Add Content section

We could add a Content section in order to store all the stuff related to content, branding and marketing (tone of voice, email signature, presentation templates, use of logos, ecc).

It could be also a great way to show interested clients a way to store, organize and present all the content stuff to their non-technical employees instead of having thousands of versioned pdf an ppt.

References

Add Downloads section

Resources / Downloads

  • Sketch (Design Kit)
  • Favicon kit? (Amber, Bitrock, Databiz)
  • Logo kit? (Amber, Bitrock, Databiz)

Fix margin and padding on Headings

Some page headings have a strange behaviour with margins and paddings, that sometimes cause them not being consistent on spacing values and not being on top of the page when clicking on the correspondent anchor link.

Some examples:

Too much space between image and About heading
schermata 2019-02-11 alle 14 09 11

Grid gutter heading not showing when clicking on the correspondent anchor link on sidebar
schermata 2019-02-11 alle 14 09 27

Travis CI integration

  • add Travis file
  • CI build the website
  • update the GitHub page
  • admin-lock the master branch

Theme

Create a custom theme for VuePress (or rewrite the default one) and apply the Amber Design System to it.

extract the theme as a standalone package

The current theme is a customization of the ejected default one. By now it covers our needs, but in the future we may want to radically redesign the website while keeping the content as-is or we may want to use this one on different VuePress websites without manually hard-encoding it.

Following the official documentation:
https://vuepress.vuejs.org/theme/using-a-theme.html#using-a-theme-from-a-dependency

We need to:

  • create a new repository amber-vuepress-theme
  • move the related code there
  • publish it on NPM as @amber-ds/vuepress-theme-docs
  • add it as a dependency here

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.