https://github.com/metafizzy/zdog-docs

Documentation site for Zdog
https://github.com/metafizzy/zdog-docs

Last synced: 3 months ago
JSON representation

Documentation site for Zdog

• Host: GitHub
• URL: https://github.com/metafizzy/zdog-docs
• Owner: metafizzy
• Created: 2019-03-12T20:13:03.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-11T23:21:19.000Z (over 1 year ago)
• Last Synced: 2024-04-10T07:31:42.325Z (7 months ago)
• Language: Handlebars
• Size: 323 KB
• Stars: 18
• Watchers: 3
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Zdog docs

Documentation site for [Zdog](https://github.com/metafizzy/zdog) - Flat, round, designer-friendly pseudo 3D engine

[zzz.dog](https://zzz.dog)

## Install

Install dependencies with npm.

``` bash

npm install

```

## Tasks

+ `gulp` - build the production site, concatenate CSS and JS, minify JS

+ `gulp dev` - build the site, but use separate CSS and JS files for debugging

+ `gulp hint` - Lint JavaScript and JSON files

## Structure

+ `assets/` - files that get copied into `build/`. Fonts and images have been ignored from the repo

+ `base/` - boilerplate CSS and JS files

+ `build/` - where static site gets built

+ `content/` - page content

+ `data/` - site data

+ `demos/` - in-page demo modules, similar to modules

+ `modules/` - See Modules below

+ `tasks/` - Gulp tasks to build the site

+ `templates/` - page templates

## Modules

Modules are re-usable components used throughout the site. A module may consist of template, JS, and CSS files.

    modules/

      page-nav/

        page-nav.css

        page-nav.js

        page-nav.hbs

[BEM](https://csswizardry.com/2013/01/mindbemding-getting-your-head-round-bem-syntax/) is used for CSS code style.

``` css

.page-nav {} /* block */

.page-nav__item {} /* element, child */

.page-nav--dark {} /* modifier */

```

JavaScript can be initialized for each element with `data-js` attribute.

``` html



```


``` js

ZdogDocs.pageNav = function( elem ) {

  // do something with elem

};

```

---

Made by [Metafizzy](https://metafizzy.co) 🌈🐻