Quickstart 🔗

Installation 🔗

Go to the releases page. Download the installer for your platform and install it.

There are no dependencies you need to install. It works on macOS, Linux and Windows.

When you type flatmark --version it should print the version of Flatmark:

            user$ flatmark --version
Flatmark CLI 1.2.3

          

Create a new site 🔗

Make a new folder for your site, e.g. my_site. Then create a new folder in it, called content. Finally, inside content, create a new file called index.md with the following content:

            # Welcome to Flatmark!

          

The structure of your site should look like this:

            my_site/
└── content/
    └── index.md

          

You can take a look at the example in GitHub for reference.

Build and serve the site 🔗

Now you can run the Flatmark CLI to generate and serve your site locally. Open a terminal, navigate to your my_site folder, and run the following command:

            user$ flatmark serve

          

Then open your browser and go to http://localhost:5555.
You should see your site with the content of index.md.

When you change a file, the site will automatically rebuild and browser will reload it.

The generated site files will be in the my_site/_site folder.