Documentation is evolving and is a WIP

Getting Started

Please follow the steps below to install Trio on your computer.

Install Node

If you don't already have Node installed, please go to Node.js and follow the directions you find there to install Node on your computer.

Install Trio

Once Node is installed on your computer, please open your terminal application and run the following command:

npm i -g @4awpawz/trio

After installing Trio you can verify your installation by running the following command:

trio -v

After running the above command you should see the version number of Trio output to the terminal.

1.0.0

Please note that the actual version number reported may differ and depends on the version of Trio that is installed.

Create A Project

In your terminal application, run the following command to create a new static site project:

$ trio new path/to/new/project/

Create A Template

In your terminal application, make the folder you created the project in the current folder.

In the project's root/source/templates folder, create a new file named default.html, and copy the following content into it:

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>

<body>
    <main data-trio-fragment></main>
</body>

</html>

Copy this to your template

Create A Fragment

In the project's root/source/fragments folder, create a new file named index.md, and copy the following content into it:

<!--
template: default
title: My First Trio Static Site
appendToTarget: true
-->

# It works!

Copy this to your fragment

Build And Run The Project

You are now ready to build your very first Trio static site project and run it in your default browser. In your terminal application, run the following command:

$ trio build -I

After running the above command, your default browser should open and display It works!

Where To Go From Here

Now that you have gotten your feet wet by installing Trio and creating your first static site with it, take a few minutes to learn more about the topics that were touched on here:

Your Financial Support Of This Project Is Greatly Appreciated

Trio is an open source project and is therefore free of charge to use both for noncommercial and commercial use, but when you use Trio to create a new website, please consider donating a few bucks. It doesn't take very long, the process is secure, and it will allow us to continue to support the community and to maintain and enhance Trio going forward.

Show your ❤️, add your ★ to the Github repo.