Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/val-town/val-town-docs

Val Town Documentation
https://github.com/val-town/val-town-docs

docs valtown

Last synced: 3 days ago
JSON representation

Val Town Documentation

Host: GitHub
URL: https://github.com/val-town/val-town-docs
Owner: val-town
Created: 2023-11-20T20:02:33.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-12-13T18:10:30.000Z (23 days ago)
Last Synced: 2024-12-30T05:31:11.447Z (6 days ago)
Topics: docs, valtown
Language: MDX
Homepage: https://docs.val.town/
Size: 24.9 MB
Stars: 39
Watchers: 5
Forks: 36
Open Issues: 22
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Val Town Docs

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

```
npm create astro@latest -- --template starlight
```

## Spell-checking

This project uses [cspell](https://cspell.org/) to keep typos at bay. You can run cspell by running
the tests:

```
npm test
```

These also run in GitHub Actions, so PRs will fail if they include new typos. If you have
introduced a new valid word that is not in the cspell dictionary and should be accepted
project-wide, add it to the list in `./project-words.txt`. If you have added a new jargon
word to a document and want to make a one-off exception, add a `cspell:ignore` comment
in that document's frontmatter, like this:

```
---
title: Your first cron val
description: Make your first cron val - a weather notifier
lastUpdated: 2024-05-09
# cspell:ignore crongpt
---
```

## 🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```

Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.

Images can be added to `src/assets/` and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

Test