---
sidebar_position: 1
---

# Quickstart

This guide shows you how to install Finboot Docs Chain on a new project.

## Prerequisites

Make sure you have installed:

* Node JS 16 or later.

## 1. Download the starter project

Copy the `docs` directory from [this repository](https://gitlab.com/finboot/it-applications/david-garcia/finboot-docusaurus-theme/-/tree/main/), and move it to the root directory of your project where you want to have docs.

:::tip

If you want to customize your site, we recommend you check out the [Docusaurus docs](https://docusaurus.io/docs).

:::


## 2. Preview the site locally

Enter the docs directory, and install the required dependencies:

```sh
cd docs
npm install
```

Then, run to start a local development server:

```sh
npm run start
```

This command opens up a browser window. Most changes are reflected live without having to restart the server.

## 3. Deploy to GitLab Pages

Create a file `gitlab-cli.yaml` in your project's root directory with the following content:

```yaml
stages:
  - pages

pages:
  stage: pages
  image: node:latest
  tags:
    - docker
  script:
    - cd docs
    - npm install
    - npm run build:gitlab
    - cd ..
    - mkdir public
    - mv docs/public/* public
  artifacts:
      paths:
      - public
  only:
    - main
```

Once you push the changes, this script will trigger a pipeline and publish your documentation to GitLab Pages every time you push a new commit to the `main` branch. 

:::info

For additional configuration options, see [GitLab Pages documentation](https://docs.gitlab.com/ee/user/project/pages/).

:::

## Next steps

It's time to add some docs! We recommend you explore the following resources to get started:

- [Docusaurus guides](https://docusaurus.io/docs/category/guides): Learn about the most important Docusaurus concepts.
- [Markdown cheatsheet](https://docusaurus.io/docs/markdown-features): Quick overview of all the Markdown syntax elements.
- [Finboot style guide](/category/contribute): Our standards for writing and designing content.