Skip to content

Latest commit

 

History

History
97 lines (68 loc) · 2.87 KB

TECHNICAL-SETUP.md

File metadata and controls

97 lines (68 loc) · 2.87 KB
Raw

Technical Setup

Install and run locally

Install packages with your package manager:

npm install

Warning

Note: This platform uses Gatsby version 5, which requires Node.js 18 or later.

Gatsby CLI

This platform uses Gatsby. For local development, you might want to install the gatsby-cli tools, which allow you to run gatsby commands directly. Install it globally with:

npm i -g gatsby-cli

Run locally

You can start the local development environment with:

npm run start

This calls the Gatsby command gatsby develop.

Platform configuration

The configuration is split into two files, located in the root folder:

  • gatsby-config.ts - the main Gatsby configuration file, including the plugin config
  • config.ts - menu/content, meta, and theme configuration

Main menu and files

The config.ts file defines the main menu and all content files that should be linked in it. This configuration is located in the navigation section and looks like this:

navigation: [
  {
    label: 'What is Topos?',
    content: [
      {
        label: 'Chapter overview: What is Topos?',
        path: '/content/module-1'
      },
      {
        label: 'Introduction',
        path: '/content/module-1/1-introduction.html'
      },
    ]
  },
  {
    label: 'First steps with Topos',
    content: [
      {
        label: 'Chapter overview: First steps with Topos',
        path: '/content/module-2'
      },
    ]
  }
]

Note

  • The top elements labeled What is Topos and First steps with Topos are the Category names (modules), which contain multiple content files (sections). Files will be displayed in the same order as configured here.
  • When linking to an index file (named index.md), you should link to the folder (eg. /content/module-1).

Important

This is the main file to inform the platform about the content structure - it also sources into the prev/next page navigation.

File names

Files are prefixed with a number indicating their position in the config. This is just for convenience when viewing the file system and does not impact the menu.

Adding new content folders

Content is located in the content folder. If you want to add another folder next to the content folder, you also need to update the includeFolder setting in the config.ts file.

Build process

You can start the build process locally with npm run build. During the build process:

  • All images are processed; images are resized to a max size, further size variants are created, and images are compressed.
  • Sharing cards (social-cards) are prepared for all pages.
  • Static html pages are generated.

The output is generated in the public folder.

Deployment

The page deploys as a static page. Preview deployments are built and deployed on Netlify. The main page deploys to GitHub Pages using a GitHub Action.