Giter VIP home page Giter VIP logo

naav's Introduction

naav

It's currently making HTML/CSS/JS files.

How to

Two cases:

  1. You only need compiled files:
  • HTML files are at project's root; HTML partials are included in src/templates/;
  • Assets (CSS, JS, images, fonts) are in dist/;
  • That's all!
  1. You wanna work within the project, let's talk.

Work in Progress

Watch your head.

This project relies on Node to ease the workflow. So you'll have to install:

  • NodeJS — I recommend the current version;
  • npm, that comes along with NodeJS.

When Node is ready to go, just cd to naav and run npm install.

Then you'll be able to work. Those Gulp tasks are available:

  • gulp sass to compile your src/scss/*.scss files — using Autoprefixer: I suggest browserl.ist to check which browsers are concerned;
  • gulp js to minify your src/js/*.js files;
  • gulp axe will perform automatic checks for accessibility using aXe Webdriver: it runs a browser and checks every URLs listed in the let test variable array. Be sure to populate it with paths to any sensible template;
  • gulp watch to run and watch sass/js/img tasks;
  • gulp nunjucks to compile HTML templates and generate HTMl files at project's root — Nunjucks is very similar to Twig, that should help;
  • gulp sync (default task) to sync your browsers and watch to JS, CSS and HTML/Nunjucks changes, serving HTML files behind localhost:3000.

You might want to use any of these tasks, but I recommend to run gulp to work comfortably.

For now, this works like a charm :)

naav's People

Contributors

ffoodd avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

naav's Issues

keyboard navigation with arrows

An almost common pattern to tab through a multi-level menu is to use arrow keys.

Should this be implemented in naav?
And are we only talking about event listeners to open or close menu? Is there anything else to take into account?

Write a doc

  • How to use?
  • How to contribute?
  • What does naav do?
  • etc.

RWD is broken :/

Needs more test and maybe another way to deal with small screens…

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.