https://github.com/crystal-linux/docs
https://github.com/crystal-linux/docs
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/crystal-linux/docs
- Owner: crystal-linux
- Created: 2022-09-11T06:26:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-15T13:34:24.000Z (over 3 years ago)
- Last Synced: 2025-03-17T02:45:31.626Z (about 1 year ago)
- Homepage: https://getcryst.al/docs/
- Size: 51.8 KB
- Stars: 4
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: .github/README.md
Awesome Lists containing this project
README
# **THIS PROJECT HAS BEEN MIGRATED TO GITLAB**
Please make any PRs here, rather than to the GitHub: https://git.getcryst.al/crystal
# REPOSITORIES HERE ARE **OUTDATED**, GO TO THE LINK BELOW
# ---- > https://git.getcryst.al/crystal < ----
# Contributing
## Entries
Start every new entry with
```markdown
---
title: An Important Entry ✅
---
Content
```
NOT
```markdown
---
title: An Important Entry
---
# An Important Entry ❌
Content
```
## Entry Config
```markdown
---
title: string
weight: number
---
```
#### `title`
A pretty title that will be displayed to the user.
#### `weight`
Entries and directories are sorted by their weights. Higher number = Higher up.
## File and directory names
Use Kebab case for filenames
| ❌ | ✅ |
| - | - |
| `an_important_entry.mdx`, `An Important Entry.mdx` | `an-important-entry.mdx` |
## Directories
Do not create directories any deeper than 1. Only top level directories for different projects.
### `.config.yaml`
Create a .config.yaml for every directory. See [Entry Config](#entry-config)