Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
Jesse Laprade ee28f41eb5 Removed redundant phrase há 1 semana
LICENSE Added agpl3 license há 2 semanas
Makefile I think i'm done?? há 2 semanas
README.md Removed redundant phrase há 1 semana
wg.fnl Improved the user experience by checking for missing files, empty build directory when building, cleaning, or serving há 2 semanas

README.md

wg

A static website generator written in Fennel.

Table of Contents

Document conventions

  • Note: Notes signify additional information.
  • Tip: Tips signify an alternative procedure for completing a step.
  • Warning: Warnings signify that damage, such as data loss, may occur.
  • Example: Examples provide a reference of how a procedure would be performed in the real world.
  • Inline code: Inline code signifies package names, filenames, or commands.
  • Code block: Code blocks signify file contents.

Requirements

Note: The fennel binary or script should be in a directory on your $PATH.

Installation

This section will guide you through downloading and installing wg either globally or locally.

This section consists of the following subsections:

Downloading wg

This section will guide you through downloading wg using git.

To download wg

  1. git clone https://git.m455.casa/m455/wg

Installing wg globally

This section will guide you through installing wg globally. This method will install wg into /usr/local/bin, which requires you to have root access to your machine.

Tip: If you don’t have root access to your machine, check out the Installing wg locally section.

To install wg globally

  1. cd wg
  2. sudo make install

Installing wg locally

This section will guide you through installing wg locally. This method will install wg into ~/.local/bin.

To install wg locally

  1. cd wg
  2. make install-local

Installing wg to a custom location

This section will guide you through installing wg to a custom location.

To install wg to a custom location

  1. cd wg
  2. make DESTDIR=~/path/to/custom/location install

Note: If you choose to install wg to a custom location, you will need to remember where you installed wg if you decide to uninstall it later.

Uninstallation

This section will guide you through uninstalling wg either globally or locally.

This section consists of the following subsections:

Uninstalling wg globally

This section will guide you through uninstalling wg globally. This method will remove wg from /usr/local/bin, which requires you to have root access to your machine.

To uninstall wg globally

  1. cd wg
  2. make uninstall

Uninstalling wg locally

This section will guide you through uninstalling wg locally. This method will remove wg from ~/.local/bin.

To uninstall wg locally

  1. cd wg
  2. make uninstall-local

Uninstalling wg from a custom location

This section will guide you through uninstalling wg from a custom location.

To uninstall wg from a custom location

  1. cd wg
  2. make DESTDIR=~/path/to/custom/location uninstall

Commands

  • init - Creates required directories and files in the current directory.

  • build

    • Recursively copies directories and files from the copy/ directory into the build/ directory.
    • Recursively converts Markdown files in the convert/ directory to HTML files in the build/ directory.
  • serve - Serves files in the ‘build/’ directory on port 8000, allowing you to see how your website will look locally before it goes live.

  • clean - Deletes all contents of the ‘build/’ directory.

  • help - Displays the help message.

Headers and footers

wg applies the header.md and footer.md to all Markdown files in the convert/ directory during the build process.

CSS

wg looks for a style.css file in the copy/ directory, and applies this to all Markdown files in the convert/ directory.

Usage

  • wg init
  • wg build
  • wg serve
  • wg clean
  • wg help