basalt-ng documentation
Docs» Getting Started

Getting Started

1. Installation

Download the pre-built basalt binary from codeberg, and add it to your path

2. Create a basalt site

In an empty directory, run:

basalt init

This will initialise a new basalt-ng website in the current working directory. This gives you nearly everything you need to get up and running, apart from a theme

3. Installing a theme

A theme is what decides the visual style of your website. It contains the HTML markup and CSS that make your website look the way it does. basalt-ng requires that atleast one theme be installed for the site to build.

You can either create your own theme entirely anew, convert your existing website's layout to a basalt theme, or download an existing published theme. This getting started manual will assume you want to use a pre-existing published theme.

Clone the basalt-themes repository, and copy the “minimal” directory into your basalt site's “theme” directory.

Now, enable the theme. Edit your “site.json” file, and set the “theme” option to “minimal”

4. Build

Finally, you can use the build command to take your site's configuration, theme and content, and output the final static markup.

Run the build command in your basalt site's directory:

basalt build

You can now find the output files in the “build” directory.

Setup Complete

Now your site is up and running, you can add posts and other content in order to have it be useful.

Previous Next

basalt-ng documentation

Table of Contents

GENERAL

  • Home/About basalt-ng
  • Download
  • Release Notes

Documentation

  • Configuration
    • Automatic Build Uploading
    • Custom Menu
    • Netlify
    • Secrets
    • Site Configuration
  • Theme Development
    • Custom Post Types
    • Theme template variables
    • Themes
  • Usage
    • Getting Started
    • Pages
    • Posts