Giter VIP home page Giter VIP logo

nubotix / hugo-base-project Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jansvabik/hugo-base-project

0.0 0.0 0.0 195 KB

This repository contains a sample Hugo project. It can be forked, cloned or copied for starting new project with this technology. Should save you a lot of time during new project creation process.

License: MIT License

Shell 5.53% JavaScript 0.65% Makefile 0.37% HTML 26.00% SCSS 67.44%

hugo-base-project's Introduction

Hugo base project

Open in Visual Studio Code

This repository contains a Hugo project template. It can be forked, cloned, or copied for starting new project with this technology. However, there are more technologies and processes implemented for minimizing human actions during starting new project.

What's in-the-box

There is a lot of ready-to-use features. You'll rather want to remove those that you're not going to use in your project. You can use, edit or remove these prepared features:

  • Sass basic files, structure and settings (in a way I use it)
  • Two content files (homepages for two langs)
  • Multilingual settings (in config.toml, content/ and i18n/)
  • Prepared basic HTML layout
  • robots.txt file where everything is allowed and sitemap link added
  • typographied partial for passing text to it, as a result, edited text with Czech typographical rules applied will be returned
  • script for creating new files for new components (check this)
  • .browserlistrc with some basic settings
  • pre-configured postcss (autoprefixer, minifier, purgecss)
  • netlify.toml file for cases when deployed on Netlify
  • ready for use with Forestry blocks (see layouts/_default/{home,list,single}.html and layouts/partials/component.html)

Scripts

There are several scripts which make the development process faster and more comfortable. They are located in scripts directory and they are usually added to Makefile for simpler usage.

New component

There is a make component name=component-name command for adding new component. It automatically creates .scss and .html file in corresponding directories, which are:

  • for .scss file -> assets/sass/components/_component-name.scss
  • for .html file -> layouts/partials/components/component-name.html
  • it also includes the .scss file to assets/sass/main.scss file

After checking that those files still don't exist and creating them, it'll also automatically open them in VS Code, if installed with CLI.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.