Elements in Pug View Engine

Last Updated : 27 Mar, 2024

Pug is a template engine that works with JavaScript libraries and frameworks. It simplifies the process of writing HTML by reducing traditional HTML syntax. It uses indentation to represent HTML structure. By using Pug you can reuse the HTML code.

In this article, we will learn about Pug Elements with its syntax and example.

Pug Elements:

Pug elements are used to define the HTML structure in Pug templates. It represents various HTML tags used to define the layout and content of a web page. Pug elements are constructed using indentation-based syntax that makes the code visually clean and easy to read.

Syntax:

The syntax for defining Pug elements is straightforward. Each element is represented by its tag name followed by optional attributes, and content and arranged hierarchically using indentation.

// This is a Pug template demonstrating basic syntax with comments

// Define document type and language
doctype html
html(lang="en")

  // Head section containing metadata and stylesheets
  head
    title My Pug Page
    meta(charset="UTF-8")
    link(rel="stylesheet", href="styles.css")
     
    // Internal CSS
    style.
       h1 {
            color:green;
       }
  // Body of the document
  body

    // Header section with an ID
    header#main-header

      // Element with class and text content
      h1.heading Welcome to My Website

      // Navigation menu with list items
      nav.menu
        ul
          // List item with class and href attribute
          li.menu-item
            a(href="#") Home
          li.menu-item
            a(href="#") About
          li.menu-item
            a(href="#") Contact

    // Main content section
    section#content
      // Container with ID and class
      .container
        // Paragraph with class and text content
        p.intro This is a demonstration of Pug syntax.
        // Image with src and alt attributes
        img.image(src="image.jpg", alt="Example Image")

    // Footer section
    footer#main-footer
      // Container with ID
      .container
        // Paragraph with text content
        p Copyright © 2024 My Website. All rights reserved.

Features of Pug Elements:

It supports variable, conditionals and loops directly in the template to generate dynamic content.
It can be easily used with NodeJS frameworks like ExpressJS.
It uses Indentation to define the structure of HTML.
It reduces the traditional HTML syntax.
It supports reusable components through mixins.
It supports use of inline JavaScript.

Steps to Create NodeJS App and Installing Module:

Step 1: Create a NodeJS application using the following command:

npm init

Step 2: Install required Dependencies:

npm i pug express

The updated dependencies in package.json file will look like:

"dependencies": {
    "express": "^4.18.2",
    "pug": "^3.0.2"
}

Example: The Below example is demonstrating the use of Pug Elements:

HTML

//File path: views/index.pug
html
  head
    // Set the title of the HTML page
    title Pug Example

    // Internal CSS styles for the page
    style.
      h1 {
        color: green;
      }
      .heading {
        font-style: italic;
      }
    
  body
    // Display the main heading of the page
    h1 GeeksForGeeks | Pug Elements
    
    // Display a subheading
    h4.heading This h4 with heading class 

    // Display a Ordered List
    ol 
      li first 
      li second 
      li third

    // Input Box
    input(
      type='text'
      name='name'
      placeholder='Enter Name'
    )

    button(type='submit') Submit

JavaScript

//File path: /index.js (root)
// Import required modules
const express = require('express');
const path = require('path');

// Create an Express application
const app = express();

// Define the port for the server to listen on
const port = 3000;

// Set Pug as the view engine
app.set('view engine', 'pug');

// Set the views directory to 'views' in the current directory
app.set('views', path.join(__dirname, 'views'));

// Define a route to render the Pug template
// when the root path is accessed
app.get('/', (req, res) => {
  // Render the Pug template named 'index'
  res.render('index');
});

// Start the server and listen on the specified port
app.listen(port, () => {
  // Display a message when the server starts successfully
  console.log(`Server is running at http://localhost:${port}`);
});