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

Migration to new home

Browse source 
- 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
Download patch file Download diff file Expand all files Collapse all files

396
.gitignore vendored
View file

@ -1,200 +1,196 @@
# hippie # HIPPIE
################### ###################
################### build/**
reports/**
build/** source/art/*.*
reports/** source/art/images/**
source/art/*.* source/art/sprites/**
source/art/images/** source/style/hippie-style/mixins/_sprite.scss
source/art/sprites/** !source/art/**/demo/
source/style/hippie-style/mixins/_sprite.scss source/templates/data.json
!source/art/**/demo/ source/data/**
source/templates/data.json !source/data/**/demo.json
source/data/**
!source/data/**/demo.json # https://gist.github.com/octocat/9257657
###################
###################
# https://gist.github.com/octocat/9257657 # Compiled source #
################### ###################
################### *.com
*.class
# Compiled source # *.dll
################### *.exe
*.com *.o
*.class *.so
*.dll
*.exe # Packages #
*.o ############
*.so # it's better to unpack these files and commit the raw source
# git has its own built in compression methods
# Packages # *.7z
############ *.dmg
# it's better to unpack these files and commit the raw source *.gz
# git has its own built in compression methods *.iso
*.7z *.jar
*.dmg *.rar
*.gz *.tar
*.iso *.zip
*.jar
*.rar # Logs and databases #
*.tar ######################
*.zip *.log
*.sql
# Logs and databases # *.sqlite
######################
*.log # OS generated files #
*.sql ######################
*.sqlite .DS_Store
.DS_Store?
# OS generated files # ._*
###################### .Spotlight-V100
.DS_Store .Trashes
.DS_Store? ehthumbs.db
._* Thumbs.db
.Spotlight-V100
.Trashes # https://github.com/github/gitignore
ehthumbs.db ###################
Thumbs.db ###################
# https://github.com/github/gitignore/blob/master/Global/Windows.gitignore
###################
# https://github.com/github/gitignore # Windows thumbnail cache files
################### Thumbs.db
################### ehthumbs.db
ehthumbs_vista.db
# https://github.com/github/gitignore/blob/master/Global/Windows.gitignore
################### # Dump file
# Windows thumbnail cache files *.stackdump
Thumbs.db
ehthumbs.db # Folder config file
ehthumbs_vista.db Desktop.ini
# Dump file # Recycle Bin used on file shares
*.stackdump $RECYCLE.BIN/
# Folder config file # Windows Installer files
Desktop.ini *.cab
*.msi
# Recycle Bin used on file shares *.msm
$RECYCLE.BIN/ *.msp
# Windows Installer files # Windows shortcuts
*.cab *.lnk
*.msi
*.msm # https://github.com/github/gitignore/blob/master/Global/macOS.gitignore
*.msp ###################
# General
# Windows shortcuts *.DS_Store
*.lnk .AppleDouble
.LSOverride
# https://github.com/github/gitignore/blob/master/Global/macOS.gitignore
################### # Icon must end with two \r
# General Icon
*.DS_Store
.AppleDouble # Thumbnails
.LSOverride ._*
# Icon must end with two \r # Files that might appear in the root of a volume
Icon .DocumentRevisions-V100
.fseventsd
# Thumbnails .Spotlight-V100
._* .TemporaryItems
.Trashes
# Files that might appear in the root of a volume .VolumeIcon.icns
.DocumentRevisions-V100 .com.apple.timemachine.donotpresent
.fseventsd
.Spotlight-V100 # Directories potentially created on remote AFP share
.TemporaryItems .AppleDB
.Trashes .AppleDesktop
.VolumeIcon.icns Network Trash Folder
.com.apple.timemachine.donotpresent Temporary Items
.apdisk
# Directories potentially created on remote AFP share
.AppleDB https://github.com/github/gitignore/blob/master/Global/Linux.gitignore
.AppleDesktop ###################
Network Trash Folder *~
Temporary Items
.apdisk # temporary files which can be created if a process still has a handle open of a deleted file
.fuse_hidden*
https://github.com/github/gitignore/blob/master/Global/Linux.gitignore
################### # KDE directory preferences
*~ .directory
# temporary files which can be created if a process still has a handle open of a deleted file # Linux trash folder which might appear on any partition or disk
.fuse_hidden* .Trash-*
# KDE directory preferences # .nfs files are created when an open file is removed but is still being accessed
.directory .nfs*
# Linux trash folder which might appear on any partition or disk # https://github.com/github/gitignore/blob/master/Node.gitignore
.Trash-* ###################
# Logs
# .nfs files are created when an open file is removed but is still being accessed logs
.nfs* *.log
npm-debug.log*
# https://github.com/github/gitignore/blob/master/Node.gitignore yarn-debug.log*
################### yarn-error.log*
# Logs
logs # Runtime data
*.log pids
npm-debug.log* *.pid
yarn-debug.log* *.seed
yarn-error.log* *.pid.lock
# Runtime data # Directory for instrumented libs generated by jscoverage/JSCover
pids lib-cov
*.pid
*.seed # Coverage directory used by tools like istanbul
*.pid.lock coverage
# Directory for instrumented libs generated by jscoverage/JSCover # nyc test coverage
lib-cov .nyc_output
# Coverage directory used by tools like istanbul # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
coverage .grunt
# nyc test coverage # Bower dependency directory (https://bower.io/)
.nyc_output bower_components
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) # node-waf configuration
.grunt .lock-wscript
# Bower dependency directory (https://bower.io/) # Compiled binary addons (http://nodejs.org/api/addons.html)
bower_components build/Release
# node-waf configuration # Dependency directories
.lock-wscript node_modules/
jspm_packages/
# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release # Typescript v1 declaration files
typings/
# Dependency directories
node_modules/ # Optional npm cache directory
jspm_packages/ .npm
# Typescript v1 declaration files # Optional eslint cache
typings/ .eslintcache
# Optional npm cache directory # Optional REPL history
.npm .node_repl_history
# Optional eslint cache # Output of 'npm pack'
.eslintcache *.tgz
# Optional REPL history # Yarn Integrity file
.node_repl_history .yarn-integrity
# Output of 'npm pack' # dotenv environment variables file
*.tgz .env
# Yarn Integrity file # https://github.com/github/gitignore/blob/master/Sass.gitignore
.yarn-integrity ###################
.sass-cache/
# dotenv environment variables file *.css.map
.env *.sass.map
*.scss.map
# https://github.com/github/gitignore/blob/master/Sass.gitignore
###################
.sass-cache/
*.css.map

42
LICENSE.md
View file

@ -1,21 +1,21 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2016 till today Stephan Hagedorn Copyright (c) 2016 till today Stephan Hagedorn
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions: furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software. copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.

37
README.md
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.

9
TODO.md
View file

@ -1,4 +1,5 @@
- add dynamic content to robots.txt during build process - add dynamic content to robots.txt during build process
- 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