Hippie interweaves preeminent personal interface elements
Go to file
sthag 31bbee51ea feat: modify intro page and new todos
- Add hgroup element to intro
- Correct some spelling
- New todos
2024-03-31 00:21:47 +01:00
gulp Modules and maintenance 2022-08-08 21:43:54 +02:00
source feat: modify intro page and new todos 2024-03-31 00:21:47 +01:00
vendor NOTE test commit from wsl 2019-03-21 20:39:53 +01:00
.eleventy.js Added possibility to start hot reloading local server 2023-10-25 22:22:19 +02:00
.eslintrc.js Modules and maintenance 2022-08-08 21:43:54 +02:00
.gitignore Migration to new home 2023-10-18 18:18:11 +02:00
.gitmodules Submodule updated to new host 2023-10-17 21:51:18 +02:00
.jshintrc Work on demo mode and readme 2020-12-22 20:10:58 +01:00
.sasslintrc NOTE test commit from wsl 2019-03-21 20:39:53 +01:00
CHANGELOG.md Added CHANGELOG 2023-10-25 21:41:45 +02:00
gulpfile.js Modules and maintenance 2022-08-08 21:43:54 +02:00
LICENSE.md Migration to new home 2023-10-18 18:18:11 +02:00
package-lock.json chore: update dependencies 2024-03-30 20:45:49 +01:00
package.json Added possibility to start hot reloading local server 2023-10-25 22:22:19 +02:00
README.md docs: add contribution section to readme 2024-03-30 20:52:37 +01:00
robots.txt NOTE test commit from wsl 2019-03-21 20:39:53 +01:00
sitemap.xml NOTE test commit from wsl 2019-03-21 20:39:53 +01:00
TODO.md feat: modify intro page and new todos 2024-03-31 00:21:47 +01:00

HIPPIE

Hippie interweaves preeminent personal interface elements

WORK IN PROGRESS (it is not ready to be used)

This is a Node.js based generator for static HTML documents.

It uses the gulp module to fiddle everything together. Styling is powered by the CSS extension language SASS. The HTML pages itself are made with the templating engine Nunjucks.

Installing

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.

Run the command git submodule update --init. This will load the submodules.

Run the command npm install. This will install all 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. Also the source files will be watched for changes which are reflected live at 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.

Content

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.

CSS classes follow a naming scheme of <object>_<description>.

  • 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 for versioning. For the versions available, see the tags on this repository.

Contribution

For contribution please use the Conventional Commits specification.
The commit type can include the following:

  • feat A new feature is introduced with the changes
  • fix A bug fix has occurred
  • chore Changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies)
  • refactor Refactored code that neither fixes a bug nor adds a feature
  • docs Updates to documentation such as a the README or other markdown files
  • style Changes that do not affect the meaning of the code, likely related to code formatting such as white-space, missing semi-colons, and so on.
  • test Including new or correcting previous tests
  • perf Performance improvements
  • ci Continuous integration related
  • build Changes that affect the build system or external dependencies
  • revert Reverts a previous commit

Authors

Stephan Hagedorn - Initial work - Interaktionsweise

License

This project is licensed under the MIT License - see the LICENSE.md file for details.