Migration to new home

- Project links updated in README
- Update to text in README
- Changed CRLF to LF for some files
- Small additions to .gitignore for Sass
This commit is contained in:
sthag 2023-10-18 18:18:11 +02:00
parent 778d7d14d5
commit 1d7f2eb839
4 changed files with 247 additions and 237 deletions

10
.gitignore vendored
View file

@ -1,7 +1,5 @@
# hippie # HIPPIE
################### ###################
###################
build/** build/**
reports/** reports/**
source/art/*.* source/art/*.*
@ -13,8 +11,6 @@ source/templates/data.json
source/data/** source/data/**
!source/data/**/demo.json !source/data/**/demo.json
# https://gist.github.com/octocat/9257657 # https://gist.github.com/octocat/9257657
################### ###################
################### ###################
@ -57,8 +53,6 @@ source/data/**
ehthumbs.db ehthumbs.db
Thumbs.db Thumbs.db
# https://github.com/github/gitignore # https://github.com/github/gitignore
################### ###################
################### ###################
@ -198,3 +192,5 @@ typings/
################### ###################
.sass-cache/ .sass-cache/
*.css.map *.css.map
*.sass.map
*.scss.map

View file

@ -2,13 +2,13 @@
> WORK IN PROGRESS (it is not ready to be used) > WORK IN PROGRESS (it is not ready to be used)
This is a [node.js](https://nodejs.org/) based generator for static HTML based sites. This is a [Node.js](https://nodejs.org/) based generator for static HTML documents.
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/). 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/).
## INSTALLATION ## Installing
Clone the repo `https://github.com/sthag/hippie.git` to a folder to create your build environment. Clone the repository `https://quelltext.interaktionsweise.de/interaktionsweise/hippie.git` to a folder to create your build environment.
Change to the newly created folder. By default this would be *hippie*. Change to the newly created folder. By default this would be *hippie*.
@ -16,30 +16,43 @@ Run the command `git submodule update --init`.
This will load the submodules. This will load the submodules.
Run the command `npm install`. Run the command `npm install`.
This will install all node.js dependencies into the folder *node_modules*. This will install all dependencies into the folder *node_modules*.
## USAGE ## Usage
The command `gulp --tasks` will give you an overview of possible actions. The command `gulp --tasks` will give you an overview of possible actions.
Run the command `gulp` for a live development environment. Run the command `gulp` for a live development environment.
This will create a folder *build* with the resulting files. 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. Also the source files will be watched for changes which are reflected live at [localhost:3000](http://localhost:3000) and the *build* directory.
`gulp build` will create the resulting *build* directory ready for deployment. `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. 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 ## Content
### Intro ### 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. 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) ### Sass (CSS)
Everything has its default style. Everything has its default style.
The lo
Class enthalten Objektnamen und Funktionen CSS classes follow a naming scheme of `<object>_<description>`.
> Sie sind mit `-` und `_` unterteilt.
> Der Bindestrich `-` trennt Objektnamen von Funktionen. Der Unterstrich `_` wiederum unterteilt Funktionsbezeichnungen. * *Object* usually is the name of the HTML element. If it is not a elemtn directly it is the thing which receives the styling
* *Description* is a name of the style e.g. what it does, how it looks
## Versioning
This project uses [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://quelltext.interaktionsweise.de/interaktionsweise/hippie/tags).
## Authors
**Stephan Hagedorn** - *Initial work* - [Interaktionsweise](https://interaktionsweise.de)
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

View file

@ -2,3 +2,4 @@
- add dynamic content to sitemap.xml - add dynamic content to sitemap.xml
- add build process for normalize.css from github.com/necolas/normalize.css - add build process for normalize.css from github.com/necolas/normalize.css
- add build process for bourbon from https://github.com/thoughtbot/bourbon - add build process for bourbon from https://github.com/thoughtbot/bourbon
- better README with more info for the content section