Install Thulite manually
This guide will walk you through the steps to manually install and configure a new Thulite project.
Prerequisites
- Node.js -
v20.11.0
or higher — runnode -v
to check. - Hugo extended -
v0.125.0
or higher — runhugo version
to check. - Text editor - We recommend VS Code — see also Editor Setup.
- Terminal - Thulite is accessed through its command-line interface (CLI).
Installation
If you prefer not to use our automatic create thulite
CLI tool, you can set up your project yourself by following the guide below.
1. Create your directory
Create an empty directory with the name of your project, and then navigate into it.
Once you are in your new directory, create your project package.json
file. This is how you will manage your project dependencies, including Thulite. If you aren’t familiar with this file format, run the following command to create one.
2. Install Thulite, Prettier and Vite
First, install the Thulite project dependencies inside your project.
Then, install Prettier and Vite — as devDependencies
:
Next, replace any placeholder “scripts” section of your package.json
with the following:
You’ll use these scripts later in the guide to start Thulite and run its different commands.
3. Create your first page
Thulite follows the Hugo content structure. In the root of your project, create an empty content
directory, and then navigate into it.
Next, create your new homepage:
In the frontmatter set draft: false
and add some content:
4. Create your first static asset
You will also want to create a static
directory to store your static assets. Hugo will always include these assets in your final build, so you can safely reference them from inside your layout templates.
In the root of your project, create an empty static
directory, and then navigate into it.
In your text editor, create a new file in your directory at static/robots.txt
. robots.txt
is a simple file that most sites will include to tell search bots like Google how to treat your site.
For this guide, copy-and-paste the following code snippet into your new file:
5. Create app.scss
In the root of your project, create an empty assets/scss
directory, and then navigate into it.
Add an app.scss
file with the following:
6. Create configuration files
Thulite follows Hugo’s configuration setup.
config/_default
directory
In the root of your project, create an empty config/_default
directory, and then navigate into it.
hugo.toml
Add a hugo.toml
file with the following:
module.toml
Add a module.toml
file with the following:
params.toml
Add a params.toml
file with the following:
config
directory
cd
one level up.
babel.config.js
Add a babel.config.js
file with the following:
postcss.config.js
Add a postcss.config.js
file with the following:
Project directory
cd
one level up.
.prettierignore
Add a .prettierignore
file with the following:
.prettierrc.yaml
Add a .prettierrc.yaml
file with the following:
Next steps
If you have followed the steps above, your project directory should now look like this:
Directoryassets/scss
- app.scss
Directoryconfig
Directory_default
- hugo.toml
- module.toml
- params.toml
- babel.config.js
- postcss.config.js
Directorycontent
- _index.md
Directorynode_modules/
- …
Directorystatic
- robots.txt
- .prettierignore
- .prettierrc.yaml
- package-lock.json # or yarn.lock, pnpm-lock.yaml, etc.
- package.json
Congratulations, you’re now set up to use Thulite!
If you followed this guide completely, you can jump directly to Step 3: Start Thulite to continue and learn how to run Thulite for the first time.
Learn