interaktionsweise/hippie
1
1
Fork 0
Code Issues Pull requests Releases 3 Activity Actions

Work on demo mode and readme

Browse source
This commit is contained in:
Stephan Hagedorn 2020-12-22 20:10:58 +01:00
parent d812ed6208
commit 84957f75a0
4 changed files with 67 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -6,7 +6,7 @@ This is a [node.js](https://nodejs.org/) based generator for static HTML based s
It uses the [gulp](https://gulpjs.com/) module to fiddle everything together. Styling is powered by the CSS extension language [SASS](https://sass-lang.com/). The HTML pages itself are made with the templating engine [Nunjucks](https://mozilla.github.io/nunjucks/).
## USAGE
## INSTALLATION
Clone the repo `https://github.com/sthag/hippie.git` to a folder to create your build environment.
@ -15,16 +15,28 @@ Change to the newly created folder. By default this would be *hippie*.
Run the command `npm install`.
This will install all node.js dependencies into the folder *node_modules*.
## USAGE
The command `gulp --tasks` will give you an overview of possible actions.
Run the command `gulp` for a live development environment.
This will create a folder *build* with the resulting files to use.
Also the source files will be watched for changes which are reflected live at [localhost:3000](htpp://localhost:3000)
This will create a folder *build* with the resulting files.
Also the source files will be watched for changes which are reflected live at [localhost:3000](htpp://localhost:3000) and the *build* directory.
`gulp build` will create the resulting *build* directory ready for deployment.
HIPPIE is intended to be used as a basis when creating HTML sites. It can be used without changes. It can be modified to have a different look and feel. It also can be used to build a new basis on top of it.
## LOGIC
> Klassennamen enthalten Objektnamen und Funktionen
### Intro
There is an *intro* page which explains the main elements and their intended usage. It uses the default styling methods and also shows variations. The page is written in german language. However it has a semantic structure and the text itself can also just be seen as example content.
### SASS (CSS)
Everything has its default style.
The lo
Class enthalten Objektnamen und Funktionen
> Sie sind mit `-` und `_` unterteilt.
> Der Bindestrich `-` trennt Objektnamen von Funktionen. Der Unterstrich `_` wiederum unterteilt Funktionsbezeichnungen.