Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
dist/
# generated types
.astro/
.vscode/

# dependencies
node_modules/
Expand All @@ -19,4 +20,6 @@ pnpm-debug.log*

# macOS-specific files
.DS_Store
.vercel

# private
shell.nix
4 changes: 0 additions & 4 deletions .gitmodules

This file was deleted.

4 changes: 0 additions & 4 deletions .vscode/extensions.json

This file was deleted.

11 changes: 0 additions & 11 deletions .vscode/launch.json

This file was deleted.

18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
# The Zane Website

---

# Deploy locally:
> The following steps assume you've already cloned the repo and you have
>`node` installed.

Inside the project folder, execute:

```bash
npm install
```

If everything went well you shoulb be able to deploy the website locally with:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is a typo in this line: 'shoulb' should be 'should'.

Suggested change
If everything went well you shoulb be able to deploy the website locally with:
If everything went well you should be able to deploy the website locally with:


```
npm run dev
```
29 changes: 29 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,33 @@
// @ts-check
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

// https://astro.build/config
export default defineConfig({
site: "https://zane-lang.org",
integrations: [
starlight({
title: 'Zane Docs',
description: 'The Zane programming language',
favicon: '/favicons/favicon.ico',

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The configured favicon path /favicons/favicon.ico does not exist in the repository. Please update it to point to an existing file, such as /favicons/zane-colorised.svg.

Suggested change
favicon: '/favicons/favicon.ico',
favicon: '/favicons/zane-colorised.svg',

logo: {
src: './src/assets/zane-black.svg',
alt: 'Black version of Zane logo',
},
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/TheLazyCat00' }],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The social link for GitHub points to a personal profile (TheLazyCat00) instead of the official organization repository (zane-lang). It should be updated to point to the organization's GitHub page.

Suggested change
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/TheLazyCat00' }],
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/zane-lang' }],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The GitHub social link currently points to a personal profile (TheLazyCat00) instead of the official Zane organization (zane-lang). Please update this to point to the official repository or organization.

Suggested change
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/TheLazyCat00' }],
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/zane-lang' }],

sidebar: [
{
label: 'Guides',
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Example Guide', slug: 'guides/example' },
],
},
{
label: 'Reference',
items: [{ autogenerate: { directory: 'reference' } }],
},
],
}),
],
});
Loading