README.md

defguard website

Editing content

Most of the content is written in HTML but some parts ware made with ease of configuration in mind.

JSON

Files inside data dare written in JSON format and contain configuration such as what items are shown in navigation and footer. Those configs are data only and so are not in Markdown

Markdown

Files that build content on website are written in .mdx files and are stored in collections within src/content directory.

Formatter

Every content file begins with special section that defines additional information for that file's context, for example title, order of display etc. You can find definitions of this information inside content.ts.

Editor recommendation

VSCode is as far the easiest to setup.

Recommended extensions

To get syntax highlights and all the good stuff, first you need to have installed Node.js and dependencies for this project installed, look in Development section.

Extensions to install:

• Astro
• Eslint
• MDX

Development

Installing dependencies

Install Node.js version specified inside .nvmrc and install pnpm
Then run install dependencies with:

pnpm install

And then run development server with:

pnpm dev

Building project

With correct Node.js environment run:

pnpm build

After that, built project should be in dist directory inside project root.