https://github.com/tinybug/pugjs-static-website

simple pugjs static website boilerplate
https://github.com/tinybug/pugjs-static-website

gulp i18n pugjs static-site vue webpack4

Last synced: about 1 month ago
JSON representation

simple pugjs static website boilerplate

• Host: GitHub
• URL: https://github.com/tinybug/pugjs-static-website
• Owner: tinybug
• Created: 2019-08-05T07:56:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T06:18:18.000Z (almost 2 years ago)
• Last Synced: 2024-09-28T08:41:26.267Z (about 2 months ago)
• Topics: gulp, i18n, pugjs, static-site, vue, webpack4
• Language: JavaScript
• Size: 3.48 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Project guide of pugjs-static-website

Frontend scaffolding tool based on Gulp 4 and Webpack 4 using pugjs, SCSS

Heavily inspired by [gulp-webpack-4-pug-scss-static-website](https://github.com/alcryalcry/gulp-webpack-4-pug-scss-static-website.git)(almost copy from this repo), but more simple and add i18n support.

## Installation

1. [Node.js](https://nodejs.org/en/download/) 

1. `npm i`

1. `cd mockapi && npm i`

## Start

1. `npm run dev` - dev server

1. `npm run build` - build to dist folder

1. `npm run production` - build minified version to dist folder

## Project structure

* `src` - source files

    * `components` - detached components

    * `layouts` - header and footer to create a basic page structure

    * `locales` - i18n locales files

    * `pages` - pages

    * `common` - general styles and scripts

        * `js` - js scripts

        * `scss` - styles in .scss format

    * `static` - any static resources that are copied to the root folder 'dist'

        * `fonts` - fonts

        * `img` - *.png, *.jpg images, favicon

        * `svg` - icons in .svg format

* `dist` - final build of the project for production

    * `assets` - static data

        * `fonts` - fonts

        * `img` - images

        * `js` - scripts

        * `css` - styles

        * `svg` - svg files

    * `*.html` - all pages

    * `index.html` - start page

## Update packages versions

1. `npm i -g npm-check-updates`

1. `ncu -u`

1. `npm install`

## license

MIT

**Author**: Alexander Shiryakov (*[email protected]*), Jesse Liu