Skip to main content

Introduction

This website aims aims to serve as a central place to put all documentation pertaining to ABAIR.ie products, services and projects. You can edit any individual page via the "Edit this page" link at the end of an article which will bring you to the github page which will allow you to edit that file directly via the web interface, as this is a documentation site feel free to make changes directly to the main branch, although any non-content changes should be performed on a branch and a pull request opened, so as not to break the site for other users during substantial changes.

This site is deployed automatically from the main branch, via Cloudflare Pages. Any changes made may take a few minutes to show up live. Below is the default documentation for making changes to the site with minor changes.

Getting Started​

What you'll need​

  • Node.js version 18.0 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Start your site​

Run the development server to serve the documentation locally:

git clone https://github.com/phonlab-tcd/docs.git
cd docs
npm run start

The cd command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open docs/intro.md (this page) and edit some lines: the site reloads automatically and displays your changes.